../_images/logo.png

YumaPro YANG Reference

The document provides an overview of each YANG module used in the YumaPro netconfd-pro server.

There are a small number of additional modules that are used in other programs.

yumapro-yang Repo on GitHub

All YANG modules in the 'netconfcentral' and 'yumaworks' directories are available on the yumapro-yang github repo.

ietf/RFC YANG Modules

iana-crypt-hash.yang

This module contains the 'crypt-hash' typedef. This data type is supported internally by the server. Passwords configured using this data type are stored as hash values. The plain-text passwords are never stored if this data type is used.

ietf-datastores.yang

This module contains the datastore-ref typedef. This data type is supported internally by the server. The --with-nmda CLI parameter must be set to true for this module to be used in the server.

ietf-inet-types.yang

This module contains the standard YANG Internet address types. These types are available for commonly used management object types. A YANG module author should check this module first, before creating any new data types with the YANG typedef statement.

There are no accessible objects in this module, so there are no SIL callback functions. The YANG data-types are supported within the YumaPro engine core modules, such as ncx/val.c and ncx/xml_wr.c.

ietf-interfaces.yang

This module contains the YumaPro interfaces table, which is just a skeleton configuration list, plus some basic interface counters. This module is intended to provide an example for embedded developers to replace this module with their own interfaces table. The YumaPro table uses information in some files found in Unix systems which support the /proc/net/dev system file.

The file libyuma-interfaces/src/yuma-interfaces.c contains the SIL callback functions for this module.

Use WITH_YUMA_INTERFACES=1 or EVERYTHING=1 make flags in order to build the libyuma-interfaces directory and install the SIL code for the yuma-interfaces YANG module. Refer to README for build instructions.

  • Source Document: RFC 8343

  • GitHub File: ietf-interfaces@2018-02-20.yang

  • YANG Tree:

    module: ietf-interfaces
      +--rw interfaces
      |  +--rw interface* [name]
      |     +--rw name                        string
      |     +--rw description?                string
      |     +--rw type                        identityref
      |     +--rw enabled?                    boolean
      |     +--rw link-up-down-trap-enable?   enumeration {if-mib}?
      |     +--ro admin-status                enumeration {if-mib}?
      |     +--ro oper-status                 enumeration
      |     +--ro last-change?                yang:date-and-time
      |     +--ro if-index                    int32 {if-mib}?
      |     +--ro phys-address?               yang:phys-address
      |     +--ro higher-layer-if*            interface-ref
      |     +--ro lower-layer-if*             interface-ref
      |     +--ro speed?                      yang:gauge64
      |     +--ro statistics
      |        +--ro discontinuity-time    yang:date-and-time
      |        +--ro in-octets?            yang:counter64
      |        +--ro in-unicast-pkts?      yang:counter64
      |        +--ro in-broadcast-pkts?    yang:counter64
      |        +--ro in-multicast-pkts?    yang:counter64
      |        +--ro in-discards?          yang:counter32
      |        +--ro in-errors?            yang:counter32
      |        +--ro in-unknown-protos?    yang:counter32
      |        +--ro out-octets?           yang:counter64
      |        +--ro out-unicast-pkts?     yang:counter64
      |        +--ro out-broadcast-pkts?   yang:counter64
      |        +--ro out-multicast-pkts?   yang:counter64
      |        +--ro out-discards?         yang:counter32
      |        +--ro out-errors?           yang:counter32
      x--ro interfaces-state
         x--ro interface* [name]
            x--ro name               string
            x--ro type               identityref
            x--ro admin-status       enumeration {if-mib}?
            x--ro oper-status        enumeration
            x--ro last-change?       yang:date-and-time
            x--ro if-index           int32 {if-mib}?
            x--ro phys-address?      yang:phys-address
            x--ro higher-layer-if*   interface-state-ref
            x--ro lower-layer-if*    interface-state-ref
            x--ro speed?             yang:gauge64
            x--ro statistics
               x--ro discontinuity-time    yang:date-and-time
               x--ro in-octets?            yang:counter64
               x--ro in-unicast-pkts?      yang:counter64
               x--ro in-broadcast-pkts?    yang:counter64
               x--ro in-multicast-pkts?    yang:counter64
               x--ro in-discards?          yang:counter32
               x--ro in-errors?            yang:counter32
               x--ro in-unknown-protos?    yang:counter32
               x--ro out-octets?           yang:counter64
               x--ro out-unicast-pkts?     yang:counter64
               x--ro out-broadcast-pkts?   yang:counter64
               x--ro out-multicast-pkts?   yang:counter64
               x--ro out-discards?         yang:counter32
               x--ro out-errors?           yang:counter32
    

ietf-origin.yang

This module contains the origin typedef. This data type is supported internally by the server. The --with-nmda CLI parameter must be set to true for this module to be used in the server.

ietf-netconf.yang

The standard NETCONF module is used to access the NETCONF operations. and is defined in RFC 6536.

The module yuma-netconf.yang is actually used in the server instead, even though this module is advertised to clients.

The agt/agt_ncx.c file contains the SIL callback functions for this module.

  • Source Document: RFC 6241

  • GitHub File: ietf-netconf@2011-06-01.yang

  • YANG Tree:

    module: ietf-netconf
    
      rpcs:
        +---x get-config
        |  +---w input
        |  |  +---w source
        |  |  |  +---w (config-source)
        |  |  |     +--:(candidate)
        |  |  |     |  +---w candidate?   empty {candidate}?
        |  |  |     +--:(running)
        |  |  |     |  +---w running?     empty
        |  |  |     +--:(startup)
        |  |  |        +---w startup?     empty {startup}?
        |  |  +---w filter?   <anyxml>
        |  +--ro output
        |     +--ro data?   <anyxml>
        +---x edit-config
        |  +---w input
        |     +---w target
        |     |  +---w (config-target)
        |     |     +--:(candidate)
        |     |     |  +---w candidate?   empty {candidate}?
        |     |     +--:(running)
        |     |        +---w running?     empty {writable-running}?
        |     +---w default-operation?   enumeration
        |     +---w test-option?         enumeration {validate}?
        |     +---w error-option?        enumeration
        |     +---w (edit-content)
        |        +--:(config)
        |        |  +---w config?        <anyxml>
        |        +--:(url)
        |           +---w url?           inet:uri {url}?
        +---x copy-config
        |  +---w input
        |     +---w target
        |     |  +---w (config-target)
        |     |     +--:(candidate)
        |     |     |  +---w candidate?   empty {candidate}?
        |     |     +--:(running)
        |     |     |  +---w running?     empty {writable-running}?
        |     |     +--:(startup)
        |     |     |  +---w startup?     empty {startup}?
        |     |     +--:(url)
        |     |        +---w url?         inet:uri {url}?
        |     +---w source
        |        +---w (config-source)
        |           +--:(candidate)
        |           |  +---w candidate?   empty {candidate}?
        |           +--:(running)
        |           |  +---w running?     empty
        |           +--:(startup)
        |           |  +---w startup?     empty {startup}?
        |           +--:(url)
        |           |  +---w url?         inet:uri {url}?
        |           +--:(config)
        |              +---w config?      <anyxml>
        +---x delete-config
        |  +---w input
        |     +---w target
        |        +---w (config-target)
        |           +--:(startup)
        |           |  +---w startup?   empty {startup}?
        |           +--:(url)
        |              +---w url?       inet:uri {url}?
        +---x lock
        |  +---w input
        |     +---w target
        |        +---w (config-target)
        |           +--:(candidate)
        |           |  +---w candidate?   empty {candidate}?
        |           +--:(running)
        |           |  +---w running?     empty
        |           +--:(startup)
        |              +---w startup?     empty {startup}?
        +---x unlock
        |  +---w input
        |     +---w target
        |        +---w (config-target)
        |           +--:(candidate)
        |           |  +---w candidate?   empty {candidate}?
        |           +--:(running)
        |           |  +---w running?     empty
        |           +--:(startup)
        |              +---w startup?     empty {startup}?
        +---x get
        |  +---w input
        |  |  +---w filter?   <anyxml>
        |  +--ro output
        |     +--ro data?   <anyxml>
        +---x close-session
        +---x kill-session
        |  +---w input
        |     +---w session-id    session-id-type
        +---x commit {candidate}?
        |  +---w input
        |     +---w confirmed?         empty {confirmed-commit}?
        |     +---w confirm-timeout?   uint32 {confirmed-commit}?
        |     +---w persist?           string {confirmed-commit}?
        |     +---w persist-id?        string {confirmed-commit}?
        +---x discard-changes {candidate}?
        +---x cancel-commit {confirmed-commit}?
        |  +---w input
        |     +---w persist-id?   string
        +---x validate {validate}?
           +---w input
              +---w source
                 +---w (config-source)
                    +--:(candidate)
                    |  +---w candidate?   empty {candidate}?
                    +--:(running)
                    |  +---w running?     empty
                    +--:(startup)
                    |  +---w startup?     empty {startup}?
                    +--:(url)
                    |  +---w url?         inet:uri {url}?
                    +--:(config)
                       +---w config?      <anyxml>
    

ietf-netconf-acm.yang

The standard NETCONF Access Control module is used to control which YANG content each group of users can access from the server.

This YANG module is used by default, is the 'ietf' ACM mode is selected, which is the default ACM mode in YumaPro. It will not be present if the server is using an external ACM instead of NACM.

The agt/agt_acm_ietf.c file contains the SIL callback functions for this module.

  • Source Document: RFC 8341

  • GitHub File: ietf-netconf-acm@2018-02-14.yang

  • YANG Tree:

    module: ietf-netconf-acm
      +--rw nacm
         +--rw enable-nacm?              boolean
         +--rw read-default?             action-type
         +--rw write-default?            action-type
         +--rw exec-default?             action-type
         +--rw enable-external-groups?   boolean
         +--ro denied-operations         yang:zero-based-counter32
         +--ro denied-data-writes        yang:zero-based-counter32
         +--ro denied-notifications      yang:zero-based-counter32
         +--rw groups
         |  +--rw group* [name]
         |     +--rw name         group-name-type
         |     +--rw user-name*   user-name-type
         +--rw rule-list* [name]
            +--rw name     string
            +--rw group*   union
            +--rw rule* [name]
               +--rw name                       string
               +--rw module-name?               union
               +--rw (rule-type)?
               |  +--:(protocol-operation)
               |  |  +--rw rpc-name?            union
               |  +--:(notification)
               |  |  +--rw notification-name?   union
               |  +--:(data-node)
               |     +--rw path                 node-instance-identifier
               +--rw access-operations?         union
               +--rw action                     action-type
               +--rw comment?                   string
    

ietf-netconf-monitoring.yang

The standard NETCONF Monitoring module is used to examine the capabilities, current state, and statistics related to the NETCONF server. The entire module is supported, and is defined in RFC 6022.

This module is also used to retrieve the actual YANG or YIN files (or URLs for them) that the server is using. Clients can use the <get-schema> RPC operation to retrieve the YANG or YIN files listed in the /netconf-state/schemas subtree.

A client will normally check the <hello> message from the server for module capabilities, and use its own local copy of a server YANG module, if it can. If not, then the <get-schema> function can be used to retrieve the YANG module.

The agt/agt_state.c file contains the SIL callback functions for this module.

  • Source Document: RFC 6022

  • GitHub File: ietf-netconf-monitoring@2010-10-04.yang

  • YANG Tree:

    module: ietf-netconf-monitoring
      +--ro netconf-state
         +--ro capabilities
         |  +--ro capability*   inet:uri
         +--ro datastores
         |  +--ro datastore* [name]
         |     +--ro name     netconf-datastore-type
         |     +--ro locks!
         |        +--ro (lock-type)?
         |           +--:(global-lock)
         |           |  +--ro global-lock
         |           |     +--ro locked-by-session    uint32
         |           |     +--ro locked-time          yang:date-and-time
         |           +--:(partial-lock)
         |              +--ro partial-lock* [lock-id]
         |                 +--ro lock-id              uint32
         |                 +--ro locked-by-session    uint32
         |                 +--ro locked-time          yang:date-and-time
         |                 +--ro select*              yang:xpath1.0
         |                 +--ro locked-node*         instance-identifier
         +--ro schemas
         |  +--ro schema* [identifier version format]
         |     +--ro identifier    string
         |     +--ro version       string
         |     +--ro format        identityref
         |     +--ro namespace     inet:uri
         |     +--ro location*     union
         +--ro sessions
         |  +--ro session* [session-id]
         |     +--ro session-id           uint32
         |     +--ro transport            identityref
         |     +--ro username             string
         |     +--ro source-host?         inet:host
         |     +--ro login-time           yang:date-and-time
         |     +--ro in-rpcs?             yang:zero-based-counter32
         |     +--ro in-bad-rpcs?         yang:zero-based-counter32
         |     +--ro out-rpc-errors?      yang:zero-based-counter32
         |     +--ro out-notifications?   yang:zero-based-counter32
         +--ro statistics
            +--ro netconf-start-time?   yang:date-and-time
            +--ro in-bad-hellos?        yang:zero-based-counter32
            +--ro in-sessions?          yang:zero-based-counter32
            +--ro dropped-sessions?     yang:zero-based-counter32
            +--ro in-rpcs?              yang:zero-based-counter32
            +--ro in-bad-rpcs?          yang:zero-based-counter32
            +--ro out-rpc-errors?       yang:zero-based-counter32
            +--ro out-notifications?    yang:zero-based-counter32
    
      rpcs:
        +---x get-schema
           +---w input
           |  +---w identifier    string
           |  +---w version?      string
           |  +---w format?       identityref
           +--ro output
              +--ro data?   <anyxml>
    

ietf-netconf-nmda.yang

The standard NETCONF operations for NMDA module is used to implement the <get-data> operation. The --with-nmda CLI parameter must be set to true for this module to be used in the server.

The agt/ietf-netconf-nmda.c file contains the SIL callback functions for this module.

  • Source Document: RFC 8527

  • GitHub File: ietf-netconf-nmda@2019-01-07.yang

  • YANG Tree:

    module: ietf-netconf-nmda
    
      augment /nc:lock/nc:input/nc:target/nc:config-target:
        +-- datastore?   ds:datastore-ref
      augment /nc:unlock/nc:input/nc:target/nc:config-target:
        +-- datastore?   ds:datastore-ref
      augment /nc:validate/nc:input/nc:source/nc:config-source:
        +-- datastore?   ds:datastore-ref
    
      rpcs:
        +---x get-data
        |  +---w input
        |  |  +---w datastore                      ds:datastore-ref
        |  |  +---w (filter-spec)?
        |  |  |  +--:(subtree-filter)
        |  |  |  |  +---w subtree-filter?          <anydata>
        |  |  |  +--:(xpath-filter)
        |  |  |     +---w xpath-filter?            yang:xpath1.0 {nc:xpath}?
        |  |  +---w config-filter?                 boolean
        |  |  +---w (origin-filters)? {origin}?
        |  |  |  +--:(origin-filter)
        |  |  |  |  +---w origin-filter*           or:origin-ref
        |  |  |  +--:(negated-origin-filter)
        |  |  |     +---w negated-origin-filter*   or:origin-ref
        |  |  +---w max-depth?                     union
        |  |  +---w with-origin?                   empty {origin}?
        |  |  +---w with-defaults?                 with-defaults-mode {with-defaults}?
        |  +--ro output
        |     +--ro data?   <anydata>
        +---x edit-data
           +---w input
              +---w datastore            ds:datastore-ref
              +---w default-operation?   enumeration
              +---w (edit-content)
                 +--:(config)
                 |  +---w config?        <anydata>
                 +--:(url)
                    +---w url?           inet:uri {nc:url}?
    

ietf-netconf-notifications.yang

The standard NETCONF Base Notifications module is used to report common NETCONF server events in the standard NETCONF notification stream. The entire module is supported, and is defined in RFC 6470.

The agt/agt_sys.c contains the SIL callback functions for this module.

  • Source Document: RFC 6470

  • GitHub File: ietf-netconf-notifications@2012-02-06.yang

  • YANG Tree:

    module: ietf-netconf-notifications
    
      notifications:
        +---n netconf-config-change
        |  +--ro changed-by
        |  |  +--ro (server-or-user)
        |  |     +--:(server)
        |  |     |  +--ro server?        empty
        |  |     +--:(by-user)
        |  |        +--ro username       string
        |  |        +--ro session-id     nc:session-id-or-zero-type
        |  |        +--ro source-host?   inet:ip-address
        |  +--ro datastore?    enumeration
        |  +--ro edit* []
        |     +--ro target?      instance-identifier
        |     +--ro operation?   nc:edit-operation-type
        +---n netconf-capability-change
        |  +--ro changed-by
        |  |  +--ro (server-or-user)
        |  |     +--:(server)
        |  |     |  +--ro server?        empty
        |  |     +--:(by-user)
        |  |        +--ro username       string
        |  |        +--ro session-id     nc:session-id-or-zero-type
        |  |        +--ro source-host?   inet:ip-address
        |  +--ro added-capability*      inet:uri
        |  +--ro deleted-capability*    inet:uri
        |  +--ro modified-capability*   inet:uri
        +---n netconf-session-start
        |  +--ro username       string
        |  +--ro session-id     nc:session-id-or-zero-type
        |  +--ro source-host?   inet:ip-address
        +---n netconf-session-end
        |  +--ro username              string
        |  +--ro session-id            nc:session-id-or-zero-type
        |  +--ro source-host?          inet:ip-address
        |  +--ro killed-by?            nc:session-id-type
        |  +--ro termination-reason    enumeration
        +---n netconf-confirmed-commit
           +--ro username         string
           +--ro session-id       nc:session-id-or-zero-type
           +--ro source-host?     inet:ip-address
           +--ro confirm-event    enumeration
           +--ro timeout?         uint32
    

ietf-netconf-partial-lock.yang

The standard NETCONF Partial Lock module is used to lock subtrees within the <running> datastore, using the <partial-lock> and <partial-unlock> operations.

The agt/agt_plock.c file contains the SIL callback functions for this module.

  • Source Document: RFC 5717

  • GitHub File: ietf-netconf-partial-lock@2009-10-19.yang

  • YANG Tree:

    module: ietf-netconf-partial-lock
    
      rpcs:
        +---x partial-lock
        |  +---w input
        |  |  +---w select*   yang:xpath1.0
        |  +--ro output
        |     +--ro lock-id        lock-id-type
        |     +--ro locked-node*   instance-identifier
        +---x partial-unlock
           +---w input
              +---w lock-id    lock-id-type
    

ietf-netconf-with-defaults.yang

The standard <with-defaults> extension to some NETCONF operations is defined in this module. The entire module is supported, and defined in RFC 6243.

This parameter is added to the following NETCONF operations:

It allows the client to control how 'default leafs' are returned by the server. The YumaPro server can be configured to use any of the default handling styles (report-all, trim, or explicit). The filtering of default nodes is handled automatically by the server support functions in agt/agt_util.c, and the XML write functions in ncx/xml_wr.c.

The --default-style CLI parameter is used in the server to pick the desired basic mode, as defined in the RFC.

  • Source Document: RFC 6243

  • GitHub File: ietf-netconf-with-defaults@2011-06-01.yang

  • YANG Tree:

    module: ietf-netconf-with-defaults
    
      augment /nc:get-config/nc:input:
        +---w with-defaults?   with-defaults-mode
      augment /nc:get/nc:input:
        +---w with-defaults?   with-defaults-mode
      augment /nc:copy-config/nc:input:
        +---w with-defaults?   with-defaults-mode
    

ietf-restconf.yang

The standard YANG extension “yang-data” is defined in this module. It is fully supported with the server, and has the same effect as the ncx:abstract extension. The module ncx/yang_data.c contains the code supporting this YANG extension.

  • Source Document: RFC 8040

  • GitHub File: ietf-restconf@2017-01-26.yang

  • YANG Tree:

    module: ietf-restconf
    
      grouping errors
        +-- errors
           +-- error* []
              +-- error-type       enumeration
              +-- error-tag        string
              +-- error-app-tag?   string
              +-- error-path?      instance-identifier
              +-- error-message?   string
              +-- error-info?      <anyxml>
      grouping restconf
        +-- restconf
           +-- data
           +-- operations
           +--ro yang-library-version    string
    

ietf-restconf-monitoring.yang

This module contains monitoring information for the RESTCONF protocol. Contains a list of protocol capability URIs and description of stream content.

The file libietf-restmonitoring/src/ietf-restconf-monitoring.c contains the SIL callback functions for this module.

Use WITH_YUMA_INTERFACES=1 or EVERYTHING=1 make flags in order to build the libietf-restmonitoring directory and install the SIL code for the ietf-restconf-monitoring YANG module. Refer to README for build instructions.

This module contains the /restconf-state subtree. It is fully supported and provides information about the RESTCONF capabilities and notification streams. The separate library libietf-restmonitoring contains the SIL callbacks for this module.

  • Source Document: RFC 8040

  • GitHub File: ietf-restconf-monitoring@2017-01-26.yang

  • YANG Tree:

    module: ietf-restconf-monitoring
      +--ro restconf-state
         +--ro capabilities
         |  +--ro capability*   inet:uri
         +--ro streams
            +--ro stream* [name]
               +--ro name                        string
               +--ro description?                string
               +--ro replay-support?             boolean
               +--ro replay-log-creation-time?   yang:date-and-time
               +--ro access* [encoding]
                  +--ro encoding    string
                  +--ro location    inet:uri
    

ietf-subscribed-notifications.yang

This module contains notification subscription management features.

The --bundle=yang-push parameter must be used for this module to be present in the server.

  • Source Document: RFC 8639

  • GitHub File: ietf-subscribed-notifications@2019-09-09.yang

  • YANG Tree:

    module: ietf-subscribed-notifications
      +--ro streams
      |  +--ro stream* [name]
      |     +--ro name                        string
      |     +--ro description?                string
      |     +--ro replay-support?             empty {replay}?
      |     +--ro replay-log-creation-time    yang:date-and-time {replay}?
      |     +--ro replay-log-aged-time?       yang:date-and-time {replay}?
      +--rw filters
      |  +--rw stream-filter* [name]
      |     +--rw name                           string
      |     +--rw (filter-spec)?
      |        +--:(stream-subtree-filter)
      |        |  +--rw stream-subtree-filter?   <anydata> {subtree}?
      |        +--:(stream-xpath-filter)
      |           +--rw stream-xpath-filter?     yang:xpath1.0 {xpath}?
      +--rw subscriptions
         +--rw subscription* [id]
            +--rw id                                         subscription-id
            +--rw (target)
            |  +--:(stream)
            |     +--rw (stream-filter)?
            |     |  +--:(by-reference)
            |     |  |  +--rw stream-filter-name             stream-filter-ref
            |     |  +--:(within-subscription)
            |     |     +--rw (filter-spec)?
            |     |        +--:(stream-subtree-filter)
            |     |        |  +--rw stream-subtree-filter?   <anydata> {subtree}?
            |     |        +--:(stream-xpath-filter)
            |     |           +--rw stream-xpath-filter?     yang:xpath1.0 {xpath}?
            |     +--rw stream                               stream-ref
            |     +--ro replay-start-time?                   yang:date-and-time {replay}?
            |     +--rw configured-replay?                   empty {configured,replay}?
            +--rw stop-time?                                 yang:date-and-time
            +--rw dscp?                                      inet:dscp {dscp}?
            +--rw weighting?                                 uint8 {qos}?
            +--rw dependency?                                subscription-id {qos}?
            +--rw transport?                                 transport {configured}?
            +--rw encoding?                                  encoding
            +--rw purpose?                                   string {configured}?
            +--rw (notification-message-origin)? {configured}?
            |  +--:(interface-originated)
            |  |  +--rw source-interface?                    if:interface-ref {interface-designation}?
            |  +--:(address-originated)
            |     +--rw source-vrf?                          -> /ni:network-instances/network-instance/name {supports-vrf}?
            |     +--rw source-address?                      inet:ip-address-no-zone
            +--ro configured-subscription-state?             enumeration {configured}?
            +--rw receivers
               +--rw receiver* [name]
                  +--rw name                      string
                  +--ro sent-event-records?       yang:zero-based-counter64
                  +--ro excluded-event-records?   yang:zero-based-counter64
                  +--ro state                     enumeration
                  +---x reset {configured}?
                     +--ro output
                        +--ro time    yang:date-and-time
    
      rpcs:
        +---x establish-subscription
        |  +---w input
        |  |  +---w (target)
        |  |  |  +--:(stream)
        |  |  |     +---w (stream-filter)?
        |  |  |     |  +--:(by-reference)
        |  |  |     |  |  +---w stream-filter-name             stream-filter-ref
        |  |  |     |  +--:(within-subscription)
        |  |  |     |     +---w (filter-spec)?
        |  |  |     |        +--:(stream-subtree-filter)
        |  |  |     |        |  +---w stream-subtree-filter?   <anydata> {subtree}?
        |  |  |     |        +--:(stream-xpath-filter)
        |  |  |     |           +---w stream-xpath-filter?     yang:xpath1.0 {xpath}?
        |  |  |     +---w stream                               stream-ref
        |  |  |     +---w replay-start-time?                   yang:date-and-time {replay}?
        |  |  +---w stop-time?                                 yang:date-and-time
        |  |  +---w dscp?                                      inet:dscp {dscp}?
        |  |  +---w weighting?                                 uint8 {qos}?
        |  |  +---w dependency?                                subscription-id {qos}?
        |  |  +---w encoding?                                  encoding
        |  +--ro output
        |     +--ro id                            subscription-id
        |     +--ro replay-start-time-revision?   yang:date-and-time {replay}?
        +---x modify-subscription
        |  +---w input
        |     +---w id                                         subscription-id
        |     +---w (target)
        |     |  +--:(stream)
        |     |     +---w (stream-filter)?
        |     |        +--:(by-reference)
        |     |        |  +---w stream-filter-name             stream-filter-ref
        |     |        +--:(within-subscription)
        |     |           +---w (filter-spec)?
        |     |              +--:(stream-subtree-filter)
        |     |              |  +---w stream-subtree-filter?   <anydata> {subtree}?
        |     |              +--:(stream-xpath-filter)
        |     |                 +---w stream-xpath-filter?     yang:xpath1.0 {xpath}?
        |     +---w stop-time?                                 yang:date-and-time
        +---x delete-subscription
        |  +---w input
        |     +---w id    subscription-id
        +---x kill-subscription
           +---w input
              +---w id    subscription-id
    
      notifications:
        +---n replay-completed {replay}?
        |  +--ro id    subscription-id
        +---n subscription-completed {configured}?
        |  +--ro id    subscription-id
        +---n subscription-modified
        |  +--ro id                                         subscription-id
        |  +--ro (target)
        |  |  +--:(stream)
        |  |     +--ro (stream-filter)?
        |  |     |  +--:(by-reference)
        |  |     |  |  +--ro stream-filter-name             stream-filter-ref
        |  |     |  +--:(within-subscription)
        |  |     |     +--ro (filter-spec)?
        |  |     |        +--:(stream-subtree-filter)
        |  |     |        |  +--ro stream-subtree-filter?   <anydata> {subtree}?
        |  |     |        +--:(stream-xpath-filter)
        |  |     |           +--ro stream-xpath-filter?     yang:xpath1.0 {xpath}?
        |  |     +--ro stream                               stream-ref
        |  |     +--ro replay-start-time?                   yang:date-and-time {replay}?
        |  +--ro stop-time?                                 yang:date-and-time
        |  +--ro dscp?                                      inet:dscp {dscp}?
        |  +--ro weighting?                                 uint8 {qos}?
        |  +--ro dependency?                                subscription-id {qos}?
        |  +--ro transport?                                 transport {configured}?
        |  +--ro encoding?                                  encoding
        |  +--ro purpose?                                   string {configured}?
        +---n subscription-resumed
        |  +--ro id    subscription-id
        +---n subscription-started {configured}?
        |  +--ro id                                         subscription-id
        |  +--ro (target)
        |  |  +--:(stream)
        |  |     +--ro (stream-filter)?
        |  |     |  +--:(by-reference)
        |  |     |  |  +--ro stream-filter-name             stream-filter-ref
        |  |     |  +--:(within-subscription)
        |  |     |     +--ro (filter-spec)?
        |  |     |        +--:(stream-subtree-filter)
        |  |     |        |  +--ro stream-subtree-filter?   <anydata> {subtree}?
        |  |     |        +--:(stream-xpath-filter)
        |  |     |           +--ro stream-xpath-filter?     yang:xpath1.0 {xpath}?
        |  |     +--ro stream                               stream-ref
        |  |     +--ro replay-start-time?                   yang:date-and-time {replay}?
        |  |     +--ro replay-previous-event-time?          yang:date-and-time {replay}?
        |  +--ro stop-time?                                 yang:date-and-time
        |  +--ro dscp?                                      inet:dscp {dscp}?
        |  +--ro weighting?                                 uint8 {qos}?
        |  +--ro dependency?                                subscription-id {qos}?
        |  +--ro transport?                                 transport {configured}?
        |  +--ro encoding?                                  encoding
        |  +--ro purpose?                                   string {configured}?
        +---n subscription-suspended
        |  +--ro id        subscription-id
        |  +--ro reason    identityref
        +---n subscription-terminated
           +--ro id        subscription-id
           +--ro reason    identityref
    

ietf-x509-cert-to-name.yang

This module contains the 'cert-to-name' grouping that is used in the yumaworks-cert-usermap.yang module to configure client certificate to username mappings for NETCONF over TLS sessions.

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

  • Source Document: RFC 7407

  • GitHub File: ietf-x509-cert-to-name@2014-12-10.yang

  • YANG Tree:

    module: ietf-x509-cert-to-name
    
      grouping cert-to-name:
        +-- cert-to-name* [id]
           +-- id?            uint32
           +-- fingerprint    x509c2n:tls-fingerprint
           +-- map-type       identityref
           +-- name           string
    

ietf-yang-library.yang

This module contains the YANG Module Library

  • NMDA version (/yang-library)

  • non-NMDA version (/modules-state)

It is fully supported and provides information about the YANG modules loaded on the server. The file libietf-yang-library/src/ietf-yang-library.c contains the SIL callback functions for this module.

The --with-nmda CLI parameter must be set to true for the NMDA version of this module to be used in the server.

Refer to the :yang-library capability section for more details.

  • Source Document: RFC 8525

  • GitHub File: ietf-yang-library@2019-01-04.yang

  • YANG Tree:

    module: ietf-yang-library
      +--ro yang-library
      |  +--ro module-set* [name]
      |  |  +--ro name                  string
      |  |  +--ro module* [name]
      |  |  |  +--ro name         yang:yang-identifier
      |  |  |  +--ro revision?    revision-identifier
      |  |  |  +--ro namespace    inet:uri
      |  |  |  +--ro location*    inet:uri
      |  |  |  +--ro submodule* [name]
      |  |  |  |  +--ro name        yang:yang-identifier
      |  |  |  |  +--ro revision?   revision-identifier
      |  |  |  |  +--ro location*   inet:uri
      |  |  |  +--ro feature*     yang:yang-identifier
      |  |  |  +--ro deviation*   -> ../../module/name
      |  |  +--ro import-only-module* [name revision]
      |  |     +--ro name         yang:yang-identifier
      |  |     +--ro revision     union
      |  |     +--ro namespace    inet:uri
      |  |     +--ro location*    inet:uri
      |  |     +--ro submodule* [name]
      |  |        +--ro name        yang:yang-identifier
      |  |        +--ro revision?   revision-identifier
      |  |        +--ro location*   inet:uri
      |  +--ro schema* [name]
      |  |  +--ro name          string
      |  |  +--ro module-set*   -> ../../module-set/name
      |  +--ro datastore* [name]
      |  |  +--ro name      ds:datastore-ref
      |  |  +--ro schema    -> ../../schema/name
      |  +--ro content-id    string
      x--ro modules-state
         x--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
    
      notifications:
        +---n yang-library-update
        |  +--ro content-id    -> /yang-library/content-id
        x---n yang-library-change
           x--ro module-set-id    -> /modules-state/module-set-id
    

ietf-yang-patch.yang

This module contains the YANG Patch Media Type, defined in RFC 8072. It is fully supported and provides the template for complex RESTCONF protocol edit requests. The DB-API protocol uses the yang-patch grouping as well. The file ncx/yang_patch.c contains basic support for this module.

The file agt/agt_yangpatch.c provides RESTCONF support for this module.

  • Source Document: RFC 8072

  • GitHub File: ietf-yang-patch@2017-02-22.yang

  • YANG Tree:

    module: ietf-yang-patch
    
      grouping yang-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>
      grouping yang-patch-status
        +-- yang-patch-status
           +-- patch-id        string
           +-- (global-status)?
           |  +--:(global-errors)
           |  |  +-- errors
           |  |     +-- error* []
           |  |        +-- error-type       enumeration
           |  |        +-- error-tag        string
           |  |        +-- error-app-tag?   string
           |  |        +-- error-path?      instance-identifier
           |  |        +-- error-message?   string
           |  |        +-- error-info?      <anyxml>
           |  +--:(ok)
           |     +-- ok?       empty
           +-- edit-status
              +-- edit* [edit-id]
                 +-- edit-id?        string
                 +-- (edit-status-choice)?
                    +--:(ok)
                    |  +-- ok?       empty
                    +--:(errors)
                       +-- errors
                          +-- error* []
                             +-- error-type       enumeration
                             +-- error-tag        string
                             +-- error-app-tag?   string
                             +-- error-path?      instance-identifier
                             +-- error-message?   string
                             +-- error-info?      <anyxml>
    

ietf-yang-push.yang

This module contains the YANG Push feature APIs.

The --bundle=yang-push parameter must be used for this module to be present in the server.

  • Source Document: RFC 8641

  • GitHub File: ietf-yang-push@2019-09-09.yang

  • YANG Tree:

    module: ietf-subscribed-notifications
      +--ro streams
      |  +--ro stream* [name]
      |     +--ro name                        string
      |     +--ro description?                string
      |     +--ro replay-support?             empty {replay}?
      |     +--ro replay-log-creation-time    yang:date-and-time {replay}?
      |     +--ro replay-log-aged-time?       yang:date-and-time {replay}?
      +--rw filters
      |  +--rw stream-filter* [name]
      |     +--rw name                           string
      |     +--rw (filter-spec)?
      |        +--:(stream-subtree-filter)
      |        |  +--rw stream-subtree-filter?   <anydata> {subtree}?
      |        +--:(stream-xpath-filter)
      |           +--rw stream-xpath-filter?     yang:xpath1.0 {xpath}?
      +--rw subscriptions
         +--rw subscription* [id]
            +--rw id                                         subscription-id
            +--rw (target)
            |  +--:(stream)
            |     +--rw (stream-filter)?
            |     |  +--:(by-reference)
            |     |  |  +--rw stream-filter-name             stream-filter-ref
            |     |  +--:(within-subscription)
            |     |     +--rw (filter-spec)?
            |     |        +--:(stream-subtree-filter)
            |     |        |  +--rw stream-subtree-filter?   <anydata> {subtree}?
            |     |        +--:(stream-xpath-filter)
            |     |           +--rw stream-xpath-filter?     yang:xpath1.0 {xpath}?
            |     +--rw stream                               stream-ref
            |     +--ro replay-start-time?                   yang:date-and-time {replay}?
            |     +--rw configured-replay?                   empty {configured,replay}?
            +--rw stop-time?                                 yang:date-and-time
            +--rw dscp?                                      inet:dscp {dscp}?
            +--rw weighting?                                 uint8 {qos}?
            +--rw dependency?                                subscription-id {qos}?
            +--rw transport?                                 transport {configured}?
            +--rw encoding?                                  encoding
            +--rw purpose?                                   string {configured}?
            +--rw (notification-message-origin)? {configured}?
            |  +--:(interface-originated)
            |  |  +--rw source-interface?                    if:interface-ref {interface-designation}?
            |  +--:(address-originated)
            |     +--rw source-vrf?                          -> /ni:network-instances/network-instance/name {supports-vrf}?
            |     +--rw source-address?                      inet:ip-address-no-zone
            +--ro configured-subscription-state?             enumeration {configured}?
            +--rw receivers
               +--rw receiver* [name]
                  +--rw name                      string
                  +--ro sent-event-records?       yang:zero-based-counter64
                  +--ro excluded-event-records?   yang:zero-based-counter64
                  +--ro state                     enumeration
                  +---x reset {configured}?
                     +--ro output
                        +--ro time    yang:date-and-time
    
      rpcs:
        +---x establish-subscription
        |  +---w input
        |  |  +---w (target)
        |  |  |  +--:(stream)
        |  |  |     +---w (stream-filter)?
        |  |  |     |  +--:(by-reference)
        |  |  |     |  |  +---w stream-filter-name             stream-filter-ref
        |  |  |     |  +--:(within-subscription)
        |  |  |     |     +---w (filter-spec)?
        |  |  |     |        +--:(stream-subtree-filter)
        |  |  |     |        |  +---w stream-subtree-filter?   <anydata> {subtree}?
        |  |  |     |        +--:(stream-xpath-filter)
        |  |  |     |           +---w stream-xpath-filter?     yang:xpath1.0 {xpath}?
        |  |  |     +---w stream                               stream-ref
        |  |  |     +---w replay-start-time?                   yang:date-and-time {replay}?
        |  |  +---w stop-time?                                 yang:date-and-time
        |  |  +---w dscp?                                      inet:dscp {dscp}?
        |  |  +---w weighting?                                 uint8 {qos}?
        |  |  +---w dependency?                                subscription-id {qos}?
        |  |  +---w encoding?                                  encoding
        |  +--ro output
        |     +--ro id                            subscription-id
        |     +--ro replay-start-time-revision?   yang:date-and-time {replay}?
        +---x modify-subscription
        |  +---w input
        |     +---w id                                         subscription-id
        |     +---w (target)
        |     |  +--:(stream)
        |     |     +---w (stream-filter)?
        |     |        +--:(by-reference)
        |     |        |  +---w stream-filter-name             stream-filter-ref
        |     |        +--:(within-subscription)
        |     |           +---w (filter-spec)?
        |     |              +--:(stream-subtree-filter)
        |     |              |  +---w stream-subtree-filter?   <anydata> {subtree}?
        |     |              +--:(stream-xpath-filter)
        |     |                 +---w stream-xpath-filter?     yang:xpath1.0 {xpath}?
        |     +---w stop-time?                                 yang:date-and-time
        +---x delete-subscription
        |  +---w input
        |     +---w id    subscription-id
        +---x kill-subscription
           +---w input
              +---w id    subscription-id
    
      notifications:
        +---n replay-completed {replay}?
        |  +--ro id    subscription-id
        +---n subscription-completed {configured}?
        |  +--ro id    subscription-id
        +---n subscription-modified
        |  +--ro id                                         subscription-id
        |  +--ro (target)
        |  |  +--:(stream)
        |  |     +--ro (stream-filter)?
        |  |     |  +--:(by-reference)
        |  |     |  |  +--ro stream-filter-name             stream-filter-ref
        |  |     |  +--:(within-subscription)
        |  |     |     +--ro (filter-spec)?
        |  |     |        +--:(stream-subtree-filter)
        |  |     |        |  +--ro stream-subtree-filter?   <anydata> {subtree}?
        |  |     |        +--:(stream-xpath-filter)
        |  |     |           +--ro stream-xpath-filter?     yang:xpath1.0 {xpath}?
        |  |     +--ro stream                               stream-ref
        |  |     +--ro replay-start-time?                   yang:date-and-time {replay}?
        |  +--ro stop-time?                                 yang:date-and-time
        |  +--ro dscp?                                      inet:dscp {dscp}?
        |  +--ro weighting?                                 uint8 {qos}?
        |  +--ro dependency?                                subscription-id {qos}?
        |  +--ro transport?                                 transport {configured}?
        |  +--ro encoding?                                  encoding
        |  +--ro purpose?                                   string {configured}?
        +---n subscription-resumed
        |  +--ro id    subscription-id
        +---n subscription-started {configured}?
        |  +--ro id                                         subscription-id
        |  +--ro (target)
        |  |  +--:(stream)
        |  |     +--ro (stream-filter)?
        |  |     |  +--:(by-reference)
        |  |     |  |  +--ro stream-filter-name             stream-filter-ref
        |  |     |  +--:(within-subscription)
        |  |     |     +--ro (filter-spec)?
        |  |     |        +--:(stream-subtree-filter)
        |  |     |        |  +--ro stream-subtree-filter?   <anydata> {subtree}?
        |  |     |        +--:(stream-xpath-filter)
        |  |     |           +--ro stream-xpath-filter?     yang:xpath1.0 {xpath}?
        |  |     +--ro stream                               stream-ref
        |  |     +--ro replay-start-time?                   yang:date-and-time {replay}?
        |  |     +--ro replay-previous-event-time?          yang:date-and-time {replay}?
        |  +--ro stop-time?                                 yang:date-and-time
        |  +--ro dscp?                                      inet:dscp {dscp}?
        |  +--ro weighting?                                 uint8 {qos}?
        |  +--ro dependency?                                subscription-id {qos}?
        |  +--ro transport?                                 transport {configured}?
        |  +--ro encoding?                                  encoding
        |  +--ro purpose?                                   string {configured}?
        +---n subscription-suspended
        |  +--ro id        subscription-id
        |  +--ro reason    identityref
        +---n subscription-terminated
           +--ro id        subscription-id
           +--ro reason    identityref
    

ietf-yang-structure-ext.yang

This module contains the sx:structure and sx:augment-structure YANG extensions.

ietf-yang-types.yang

This module contains the standard YANG general user data types. These types are available for commonly used derived types. A YANG module author should check this module first, before creating any new data types with the YANG typedef statement.

There are no accessible objects in this module, so there are no SIL callback functions. The YANG data-types are supported within the YumaPro engine core modules, such as ncx/val.c and ncx/xml_wr.c.

nc-notifications.yang

This module is based on the definition in RFC 5277, the NETCONF Notifications specification. It contains the <replayComplete> and <notificationComplete> notification event definitions.

The file agt/agt_not.c contains the SIL support code for this module.

  • Source Document: None: Based on RFC 5277

  • GitHub File: None

  • YANG Tree:

    module: nc-notifications
      +--ro netconf
         +--ro streams
            +--ro stream* [name]
               +--ro name                     ncEvent:streamNameType
               +--ro description              string
               +--ro replaySupport            boolean
               +--ro replayLogCreationTime?   yang:date-and-time
    
      notifications:
        +---n replayComplete
        +---n notificationComplete
    

notifications.yang

This module is based on the definition in RFC 5277, the NETCONF Notifications specification.

  • All of this RFC is supported in the server.

  • This module contains the <create-subscription> RPC operation.

  • The notification replay feature is controlled with the --eventlog-size configuration parameter.

  • The <create-subscription> operation is fully supported, including XPath and subtree filters.

  • The ietf-netconf-acm.yang module can be used to control what notification events a user is allowed to receive.

  • The <create-subscription> filter allows the client to select which notification events it wants to receive.

The file agt/agt_not.c contains the SIL callback functions for this modules.

  • Source Document: None: Based on RFC 5277

  • GitHub File: None

  • YANG Tree:

    module: notifications
      +--ro notification
         +--ro eventTime      yang:date-and-time
         +--ro sequence-id?   uint32
    
      rpcs:
        +---x create-subscription
           +---w input
              +---w stream?      streamNameType
              +---w filter?      <anyxml>
              +---w startTime?   yang:date-and-time
              +---w stopTime?    yang:date-and-time
    

netconfcentral YANG Modules

toaster.yang

This module contains an example YANG module used in some tutorials in YumaPro SDK.

The SIL callback functions for this module are installed in the /usr/share/yumapro/src/toaster directory.

  • Source Document: None

  • GitHub File: toaster.yang

  • YANG Tree: none

    module: toaster
      +--rw toaster!
         +--ro toasterManufacturer    DisplayString
         +--ro toasterModelNumber     DisplayString
         +--ro toasterStatus          enumeration
    
      rpcs:
        +---x make-toast
        |  +---w input
        |     +---w toasterDoneness?    uint32
        |     +---w toasterToastType?   identityref
        +---x cancel-toast
    
      notifications:
        +---n toastDone
           +--ro toastStatus?   enumeration
    

yuma-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 SIL callback functions for the common groupings in this module are found in ncx/val_util.c, such as the 'val_set_feature_parms' function.

yuma-arp.yang

This module contains a collection of YANG definitions for configuring and monitoring ARP.

If server source files are available, then the SIL code for this module can be found in the libyuma-arp/src directory. This SIL code uses deprecated GET1 and EDIT1 callback APIs and is no longer considered current.

Note

This module is obsolete. Do not use.

  • Source Document: None

  • GitHub File: yuma-arp.yang

  • YANG Tree:

    module: yuma-arp
      +--rw arp
         +--rw arp-settings
         |  +--rw maximum-entries?    uint32
         |  +--rw validity-timeout?   uint32
         +--rw static-arps
         |  +--rw static-arp* [ip-address]
         |     +--rw ip-address     inet:ipv4-address
         |     +--rw mac-address?   yang:mac-address
         +--ro dynamic-arps
            +--ro dynamic-arp* [ip-address]
               +--ro ip-address     inet:ipv4-address
               +--ro mac-address?   yang:mac-address
    

yuma-interfaces.yang

This module contains a collection of YANG definitions for monitoring interface statistics.

If server source files are available, then the SIL code for this module can be found in the libyuma-interfaces/src directory. This SIL code uses deprecated GET1 callback APIs and is no longer considered current.

Note

This module is obsolete. Do not use.

  • Source Document: None

  • GitHub File: yuma-interfaces.yang

  • YANG Tree:

    module: yuma-interfaces
      +--rw interfaces
         +--rw interface* [name]
            +--rw name        string
            +--ro counters
               +--ro inBytes?         yang:counter64
               +--ro inPackets?       yang:counter64
               +--ro inErrors?        yang:counter64
               +--ro inDrops?         yang:counter64
               +--ro inFifo?          yang:counter64
               +--ro inFrames?        yang:counter64
               +--ro inCompressed?    yang:counter64
               +--ro inMulticast?     yang:counter64
               +--ro outBytes?        yang:counter64
               +--ro outPackets?      yang:counter64
               +--ro outErrors?       yang:counter64
               +--ro outDrops?        yang:counter64
               +--ro outFifo?         yang:counter64
               +--ro outCollisions?   yang:counter64
               +--ro outCarrier?      yang:counter64
               +--ro outCompressed?   yang:counter64
    

yuma-mysession.yang

This module provides the YumaPro proprietary <get-my-session> and <set-my-session> RPC operations. These are used by the client to set some session output preferences, such as the desired line length, indentation amount, and defaults handling behavior. This is not a built-in module. It has to be loaded with the --module parameter.

The SIL callbacks for this module are located in the separate library libyuma-mysession.

  • Source Document: None

  • GitHub File: yuma-mysession.yang

  • YANG Tree:

    module: yuma-mysession
    
      rpcs:
        +---x get-my-session
        |  +--ro output
        |     +--ro indent?           yt:IndentType
        |     +--ro linesize?         uint32
        |     +--ro with-defaults?    wd:with-defaults-mode
        |     +--ro message-indent?   int8
        +---x set-my-session
           +---w input
              +---w indent?           yt:IndentType
              +---w linesize?         uint32
              +---w with-defaults?    wd:with-defaults-mode
              +---w message-indent?   int8
    

yuma-nacm.yang

This module contains a pre-standard version of the NACM data model for access control. The ietf-netconf-acm.yang module is based on this module.

Note

This module is obsolete. Do not use.

  • Source Document: None

  • GitHub File: yuma-nacm.yang

  • YANG Tree:

    module: yuma-nacm
      +--rw nacm!
         +--rw enable-nacm?          boolean
         +--rw read-default?         nacm-action
         +--rw write-default?        nacm-action
         +--rw exec-default?         nacm-action
         +--ro denied-rpcs?          yang:zero-based-counter32
         +--ro denied-data-writes?   yang:zero-based-counter32
         +--rw groups
         |  +--rw group* [group-identity]
         |     +--rw group-identity    nacm-group
         |     +--rw user-name*        nacm-user-name
         +--rw rules
            +--rw module-rule* [module-name rule-name]
            |  +--rw module-name       yt:yang-identifier
            |  +--rw rule-name         string
            |  +--rw allowed-rights    nacm-rights
            |  +--rw allowed-group*    nacm-group
            |  +--rw comment?          string
            +--rw rpc-rule* [rpc-module-name rpc-name rule-name]
            |  +--rw rpc-module-name    yt:yang-identifier
            |  +--rw rpc-name           yt:yang-identifier
            |  +--rw rule-name          string
            |  +--rw allowed-rights     nacm-rights
            |  +--rw allowed-group*     nacm-group
            |  +--rw comment?           string
            +--rw data-rule* [rule-name]
            |  +--rw path              schema-instance-identifier
            |  +--rw rule-name         string
            |  +--rw allowed-rights    nacm-rights
            |  +--rw allowed-group*    nacm-group
            |  +--rw comment?          string
            +--rw notification-rule* [notification-module-name notification-name rule-name]
               +--rw notification-module-name    yt:yang-identifier
               +--rw notification-name           yt:yang-identifier
               +--rw rule-name                   string
               +--rw allowed-rights              nacm-rights
               +--rw allowed-group*              nacm-group
               +--rw comment?                    string
    

yuma-ncx.yang

This module provides 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.

  • Source Document: None

  • GitHub File: yuma-ncx.yang

  • YANG Tree: none

yuma-netconf.yang

This module pre-dates ietf-netconf.yang. It is a superset of that module and used internally within the server to implement NETCONF operations.

The file agt/agt_ncx.c contains most the SIL callback functions for this module.

This module is not advertised in the server capabilities. It is only used internally within the server.

  • Source Document: None

  • GitHub File: yuma-netconf.yang

  • YANG Tree:

    module: yuma-netconf
      +--rw server-hello
      |  +--ro capabilities
      |  |  +--ro capability*   inet:uri
      |  +--ro session-id?     session-id-type
      +--rw client-hello
      |  +--ro capabilities
      |     +--ro capability*   inet:uri
      +--rw operation?      edit-operation-type
      +--rw rpc
      +--rw rpc-reply
      |  +--ro (ok-or-data-error)
      |     +--:(ok)
      |     |  +--ro ok?          empty
      |     +--:(data-error)
      |        +--ro rpc-error* []
      |           +--ro error-type        ErrorType
      |           +--ro error-tag         error-tag-type
      |           +--ro error-severity    error-severity-type
      |           +--ro error-app-tag?    string
      |           +--ro error-path?       yang:xpath1.0
      |           +--ro error-message?    LangString
      |           +--ro error-info?       <anyxml>
      +--rw config
    
      rpcs:
        +---x get-config
        |  +---w input
        |  |  +---w source
        |  |  |  +---w (config-source)
        |  |  |     +--:(candidate)
        |  |  |     |  +---w candidate?   empty {candidate}?
        |  |  |     +--:(running)
        |  |  |     |  +---w running?     empty
        |  |  |     +--:(startup)
        |  |  |        +---w startup?     empty {startup}?
        |  |  +---w filter?   <anyxml>
        |  +--ro output
        |     +--ro data!
        +---x edit-config
        |  +---w input
        |     +---w target
        |     |  +---w (config-target)
        |     |     +--:(candidate)
        |     |     |  +---w candidate?   empty {candidate}?
        |     |     +--:(running)
        |     |        +---w running?     empty {writable-running}?
        |     +---w default-operation?   DefaultOperationType
        |     +---w test-option?         TestOptionType {validate}?
        |     +---w error-option?        ErrorOptionType
        |     +---w (edit-content)
        |        +--:(config)
        |        |  +---w config
        |        +--:(url)
        |           +---w url?           inet:uri {url}?
        +---x copy-config
        |  +---w input
        |     +---w target
        |     |  +---w (config-target)
        |     |     +--:(candidate)
        |     |     |  +---w candidate?   empty {candidate}?
        |     |     +--:(running)
        |     |     |  +---w running?     empty {writable-running}?
        |     |     +--:(startup)
        |     |     |  +---w startup?     empty {startup}?
        |     |     +--:(url)
        |     |        +---w url?         inet:uri {url}?
        |     +---w source
        |        +---w (config-source)
        |           +--:(candidate)
        |           |  +---w candidate?   empty {candidate}?
        |           +--:(running)
        |           |  +---w running?     empty
        |           +--:(startup)
        |           |  +---w startup?     empty {startup}?
        |           +--:(url)
        |           |  +---w url?         inet:uri {url}?
        |           +--:(config)
        |              +---w config
        +---x delete-config
        |  +---w input
        |     +---w target
        |        +---w (config-target)
        |           +--:(startup)
        |           |  +---w startup?   empty {startup}?
        |           +--:(url)
        |              +---w url?       inet:uri {url}?
        +---x lock
        |  +---w input
        |     +---w target
        |        +---w (config-target)
        |           +--:(candidate)
        |           |  +---w candidate?   empty {candidate}?
        |           +--:(running)
        |           |  +---w running?     empty
        |           +--:(startup)
        |              +---w startup?     empty {startup}?
        +---x unlock
        |  +---w input
        |     +---w target
        |        +---w (config-target)
        |           +--:(candidate)
        |           |  +---w candidate?   empty {candidate}?
        |           +--:(running)
        |           |  +---w running?     empty
        |           +--:(startup)
        |              +---w startup?     empty {startup}?
        +---x get
        |  +---w input
        |  |  +---w filter?   <anyxml>
        |  +--ro output
        |     +--ro data!
        +---x close-session
        +---x kill-session
        |  +---w input
        |     +---w session-id    session-id-type
        +---x commit {candidate}?
        |  +---w input
        |     +---w confirmed?         empty {confirmed-commit}?
        |     +---w confirm-timeout?   ConfirmTimeoutType {confirmed-commit}?
        |     +---w persist?           string {confirmed-commit}?
        |     +---w persist-id?        string {confirmed-commit}?
        +---x discard-changes {candidate}?
        +---x cancel-commit {confirmed-commit}?
        |  +---w input
        |     +---w persist-id?   string
        +---x validate {validate}?
        |  +---w input
        |     +---w source
        |        +---w (config-source)
        |           +--:(candidate)
        |           |  +---w candidate?   empty {candidate}?
        |           +--:(running)
        |           |  +---w running?     empty
        |           +--:(startup)
        |           |  +---w startup?     empty {startup}?
        |           +--:(url)
        |           |  +---w url?         inet:uri {url}?
        |           +--:(config)
        |              +---w config
        +---x load-config
           +---w input
              +---w config
    

yuma-proc.yang

This module provides some Unix /proc file-system data, in nested XML format. This module will not load if the files /proc/meminfo and /proc/cpuinfo are not found.

If server source files are available, then the SIL code for this module can be found in the libyuma-proc/src directory. This SIL code uses deprecated GET1 callback APIs and is no longer considered current.

  • Source Document: None

  • GitHub File: yuma-proc.yang

  • YANG Tree:

    module: yuma-proc
      +--ro proc
         +--ro cpuinfo
         |  +--ro cpu* [processor]
         |     +--ro processor           uint32
         |     +--ro vendor_id?          string
         |     +--ro cpu_family?         uint32
         |     +--ro model?              uint32
         |     +--ro model_name?         string
         |     +--ro stepping?           uint32
         |     +--ro microcode?          string
         |     +--ro cpu_MHz?            decimal64
         |     +--ro cache_size?         string
         |     +--ro physical_id?        uint32
         |     +--ro siblings?           uint32
         |     +--ro core_id?            uint32
         |     +--ro cpu_cores?          uint32
         |     +--ro apicid?             uint32
         |     +--ro initial_apicid?     uint32
         |     +--ro fdiv_bug?           YesNo
         |     +--ro hlt_bug?            YesNo
         |     +--ro f00f_bug?           YesNo
         |     +--ro coma_bug?           YesNo
         |     +--ro fpu?                YesNo
         |     +--ro fpu_exception?      YesNo
         |     +--ro cpuid_level?        uint32
         |     +--ro wp?                 YesNo
         |     +--ro flags?              string
         |     +--ro bogomips?           decimal64
         |     +--ro TLB_size?           string
         |     +--ro clflush_size?       uint32
         |     +--ro cache_alignment?    uint32
         |     +--ro address_sizes?      string
         |     +--ro power_management?   string
         +--ro meminfo
            +--ro MemTotal?            string
            +--ro MemFree?             string
            +--ro Buffers?             string
            +--ro Cached?              string
            +--ro SwapCached?          string
            +--ro Active?              string
            +--ro Active_anon_?        string
            +--ro Active_file_?        string
            +--ro Inactive?            string
            +--ro Inactive_anon_?      string
            +--ro Inactive_file_?      string
            +--ro Unevictable?         string
            +--ro Mlocked?             string
            +--ro HighTotal?           string
            +--ro HighFree?            string
            +--ro LowTotal?            string
            +--ro LowFree?             string
            +--ro SwapTotal?           string
            +--ro SwapFree?            string
            +--ro Dirty?               string
            +--ro Writeback?           string
            +--ro AnonPages?           string
            +--ro Mapped?              string
            +--ro Shmem?               string
            +--ro Slab?                string
            +--ro SReclaimable?        string
            +--ro SUnreclaim?          string
            +--ro KernelStack?         string
            +--ro PageTables?          string
            +--ro NFS_Unstable?        string
            +--ro Bounce?              string
            +--ro WritebackTmp?        string
            +--ro CommitLimit?         string
            +--ro Committed_AS?        string
            +--ro VmallocTotal?        string
            +--ro VmallocUsed?         string
            +--ro VmallocChunk?        string
            +--ro HardwareCorrupted?   string
            +--ro AnonHugePages?       string
            +--ro HugePages_Total?     uint32
            +--ro HugePages_Free?      uint32
            +--ro HugePages_Rsvd?      uint32
            +--ro HugePages_Surp?      uint32
            +--ro Hugepagesize?        string
            +--ro DirectMap4k?         string
            +--ro DirectMap2M?         string
            +--ro DirectMap4M?         string
    

yuma-system.yang

This module contains the YumaPro /system data structure, providing basic server information, unix 'uname' data, and all the YumaPro proprietary notification event definitions.

The --with-yuma-system CLI parameter must be set to true for this module to be present in the server.

The file agt/agt_sys.c contains the SIL callback functions for this module.

  • Source Document: None

  • GitHub File: yuma-system.yang

  • YANG Tree:

    module: yuma-system
      +--ro system
         +--ro sysName?                         string
         +--ro sysCurrentDateTime?              yang:date-and-time
         +--ro sysBootDateTime?                 yang:date-and-time
         +--ro sysLogLevel?                     nt:NcDebugType
         +--ro sysNetconfServerId?              string
         +--ro sysNetconfStartupSource?         enumeration
         +--ro sysNetconfStartupFilespec?       string
         +--ro sysNetconfStartupTxidFilespec?   string
         +--ro sysNetconfServerCLI?             <anyxml>
         +--ro uname
            +--ro sysname?    string
            +--ro release?    string
            +--ro version?    string
            +--ro machine?    string
            +--ro nodename?   string
    
      rpcs:
        +---x set-log-level
        |  +---w input
        |     +---w log-level    nt:NcDebugType
        +---x load
        |  +---w input
        |  |  +---w module       nt:NcxName
        |  |  +---w revision?    nt:Date
        |  |  +---w deviation*   yt:NcModuleSpec
        |  +--ro output
        |     +--ro mod-revision?   nt:Date
        +---x restart
        +---x shutdown
        +---x no-op
    
      notifications:
        +---n sysStartup
        |  +--ro startupSource?   string
        |  +--ro bootError* []
        |     +--ro error-type        enumeration
        |     +--ro error-tag         nc:error-tag-type
        |     +--ro error-severity    nc:error-severity-type
        |     +--ro error-app-tag?    string
        |     +--ro error-path?       yang:xpath1.0
        |     +--ro error-message?    LangString2
        |     +--ro error-info?       <anyxml>
        +---n sysConfigChange
        |  +--ro userName?     string
        |  +--ro sessionId     nc:session-id-type
        |  +--ro remoteHost?   inet:ip-address
        |  +--ro edit* []
        |     +--ro target?      instance-identifier
        |     +--ro operation?   nc:edit-operation-type
        +---n sysCapabilityChange
        |  +--ro changed-by
        |  |  +--ro (server-or-user)?
        |  |     +--:(server)
        |  |     |  +--ro server?       empty
        |  |     +--:(by-user)
        |  |        +--ro userName?     string
        |  |        +--ro sessionId     nc:session-id-type
        |  |        +--ro remoteHost?   inet:ip-address
        |  +--ro added-capability*     inet:uri
        |  +--ro deleted-capability*   inet:uri
        +---n sysSessionStart
        |  +--ro userName?     string
        |  +--ro sessionId     nc:session-id-type
        |  +--ro remoteHost?   inet:ip-address
        +---n sysSessionEnd
        |  +--ro userName?            string
        |  +--ro sessionId            nc:session-id-type
        |  +--ro remoteHost?          inet:ip-address
        |  +--ro killedBy?            nc:session-id-type
        |  +--ro terminationReason    enumeration
        +---n sysConfirmedCommit
           +--ro userName?       string
           +--ro sessionId       nc:session-id-type
           +--ro remoteHost?     inet:ip-address
           +--ro confirmEvent    enumeration
    

yuma-time-filter.yang

This module contains the YumaPro last-modified leaf, which extends the standard /netconf-state/datastores/datastore structure in ietf-netconf-monitoring.yang, with the database last-modified timestamp. The standard <get> and <get-config> operations are augmented with the if-modified-since leaf, to allow all-or-none filtering of the configuration, based on its modification timestamp.

This module will not be present in the server if the --with-yuma-time-filter CLI parameter is set to false.

The file agt/agt_sys.c contains the SIL callback functions for this module.

  • Source Document: None

  • GitHub File: yuma-time-filter.yang

  • YANG Tree:

    module: yuma-time-filter
    
      augment /mon:netconf-state/mon:datastores/mon:datastore:
        +--ro last-modified?   yang:date-and-time
      augment /nc:get-config/nc:input:
        +---w if-modified-since?   yang:date-and-time
      augment /nc:get/nc:input:
        +---w if-modified-since?   yang:date-and-time
    

yuma-types.yang

This module provides some common data types that are used by other YumaPro YANG modules.

There are no SIL callback functions for this module.

yuma-xsd.yang

This module provides some internal data types that used to be used by the yangdump-pro program to translate YANG modules to XSD files.

There are no SIL callback functions for this module.

Note

This module is obsolete. Do not use.

  • Source Document: None

  • GitHub File: yuma-xsd.yang

  • YANG Tree: None

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
    

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
    
      grouping StartupChoice
        +-- (start)?
           +--:(no-startup)
           |  +-- no-startup?        empty
           +--:(factory-startup)
           |  +-- factory-startup?   empty
           +--:(startup)
              +-- startup?           string
      grouping WatcherChoice
        +-- (watcher-parm)?
           +--:(no-watcher)
           |  +-- no-watcher?         empty
           +--:(watcher-interval)
              +-- watcher-interval?   uint32
      grouping netconfd-pro-parms
        +-- 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-vendor?                     empty
        +-- log-vendor-level?               yt:NcDebugType
        +-- message-indent?                 int8
        +-- yumapro-home?                   string
        +-- loadpath?                       yt:NcPathList
        +-- subdirs?                        boolean
        +-- 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
        +-- create-empty-npcontainers?      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
        +-- idle-timeout?                   uint32
        +-- import-version-bestmatch?       boolean
        +-- insecure-ok?                    boolean
        +-- library-mode?                   boolean
        +-- max-burst?                      uint32
        +-- max-getbulk?                    uint32
        +-- max-sessions?                   uint16
        +-- max-cli-sessions?               uint16
        +-- 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
        +-- restconf-capability*            inet:uri
        +-- restconf-default-encoding?      enumeration
        +-- restconf-strict-headers?        boolean
        +-- return-status?                  boolean
        +-- running-error?                  enumeration
        +-- save-owners?                    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
        +-- 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
        x-- system-sorted?                  boolean
        +-- target?                         enumeration
        +-- tls-crl-missing-ok?             boolean
        +-- tls-crl-mode?                   enumeration
        +-- trim-whitespace?                boolean
        +-- log-event-drops?                boolean
        +-- log-pthread-level?              nt:NcDebugType
        x-- session-sync-mutex?             empty
        +-- server-id?                      nt:NcxName
        +-- usexmlorder?                    empty
        +-- (watcher-parm)?
        |  +--:(no-watcher)
        |  |  +-- no-watcher?               empty
        |  +--:(watcher-interval)
        |     +-- watcher-interval?         uint32
        +-- wait-datastore-ready?           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-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-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-callhome?        boolean
        +-- with-yumaworks-event-stream?    boolean
        +-- with-yumaworks-ids?             boolean
        +-- with-yumaworks-system?          boolean
        +-- with-yumaworks-templates?       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
    

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

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
    

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.

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 yangcli-pro
      |  +--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 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 message-indent?            int8
      |  +--rw yumapro-home?              string
      |  +--rw use-data-templates?        boolean
      |  +--rw ignore-missing-vars?       boolean
      |  +--rw use-session-vars?          boolean
      |  +--rw save-session-vars?         boolean
      |  +--rw feature-enable-default?    boolean
      |  +--rw feature-enable*            yt:FeatureSpec
      |  +--rw feature-disable*           yt:FeatureSpec
      |  +--rw subdirs?                   boolean
      |  +--rw home?                      string
      |  +--rw user?                      nt:NcxUserName
      |  +--rw server?                    inet:host
      |  +--rw (pass)?
      |  |  +--:(password)
      |  |  |  +--rw password?            string
      |  |  +--:(no-password)
      |  |     +--rw no-password?         empty
      |  +--rw ncport?                    uint16
      |  +--rw timeout?                   nt:Timeout
      |  +--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 protocols?                 bits
      |  +--rw entry-point?               string
      |  +--rw transport?                 ywt:transport-type
      |  +--rw encoding?                  ywt:encoding-type
      |  +--rw with-ocpattern?            boolean
      |  +--rw binary-display-maxlen?     uint32
      |  +--rw match-names?               ywt:NameMatchMode
      |  +--rw alt-names?                 ywt:AltNameMode
      |  +--rw wildcard-keys?             boolean
      |  +--rw with-term-msg?             boolean
      |  +--rw ask-password?              boolean
      |  +--rw aliases-file?              string
      |  +--rw allow-shell?               boolean
      |  +--rw autocomp?                  boolean
      |  +--rw autoconfig?                boolean
      |  +--rw autoconfig-conf-mode?      boolean
      |  +--rw autoaliases?               boolean
      |  +--rw autoload?                  boolean
      |  +--rw autoload-get?              boolean
      |  +--rw autoload-cache?            boolean
      |  +--rw autoload-save-cache?       boolean
      |  +--rw auto-discard-changes?      boolean
      |  +--rw auto-keepalive?            boolean
      |  +--rw auto-reconnect?            boolean
      |  +--rw auto-reconnect-interval?   uint16
      |  +--rw auto-reconnect-max?        uint16
      |  +--rw autodevices?               boolean
      |  +--rw autohistory?               boolean
      |  +--rw autonotif?                 boolean
      |  +--rw autonvsave?                boolean
      |  +--rw autoschemaservers?         boolean
      |  +--rw autosessions?              boolean
      |  +--rw autotest?                  boolean
      |  +--rw autousers?                 boolean
      |  +--rw autoeventhandlers?         boolean
      |  +--rw autouservars?              boolean
      |  +--rw bad-data?                  enumeration
      |  +--rw batch-mode?                empty
      |  +--rw break-key-mode?            enumeration
      |  +--rw callhome-address?          inet:ip-address
      |  +--rw callhome-enabled?          boolean
      |  +--rw callhome-port?             inet:port-number
      |  +--rw callhome-tls-port?         inet:port-number
      |  +--rw callhome-user*             nt:NcxUserName
      |  +--rw check-output?              boolean
      |  +--rw check-output-error?        boolean
      |  +--rw check-replies?             boolean
      |  +--rw check-replies-error?       boolean
      |  +--rw config-edit-mode?          config-edit-mode-type
      |  +--rw config-commit-mode?        boolean
      |  +--rw config-autosave?           boolean
      |  +--rw with-enable-mode?          boolean
      |  +--rw default-module?            nt:NcxName
      |  +--rw disable-command*           nt:NcxIdentifier
      |  +--rw display-mode?              enumeration
      |  +--rw echo-notif-loglevel?       nt:NcDebugType
      |  +--rw echo-notifs?               boolean
      |  +--rw echo-replies?              boolean
      |  +--rw fixorder?                  boolean
      |  +--rw force-target?              enumeration
      |  +--rw module*                    yt:NcModuleSpec
      |  +--rw deviation*                 yt:NcModuleSpec
      |  +--rw datapath?                  yt:NcPathList
      |  +--rw runpath?                   yt:NcPathList
      |  +--rw handle-bad-reply?          enumeration
      |  +--rw help-width?                uint16
      |  +--rw history-file?              string
      |  +--rw insecure-ok?               boolean
      |  +--rw keepalive-interval?        uint32
      |  +--rw no-aliases?                empty
      |  +--rw fill-optional?             boolean
      |  +--rw optional?                  boolean
      |  +--rw prompt?                    string
      |  +--rw prompt-name?               string
      |  +--rw prompt-type?               ywt:show-mode
      |  +--rw restrict-edit-mode?        boolean
      |  +--rw (run-startup-mode)?
      |  |  +--:(run-script)
      |  |  |  +--rw run-script?          string
      |  |  +--:(run-command)
      |  |     +--rw run-command?         string
      |  +--rw script-input?              boolean
      |  +--rw server-commands?           boolean
      |  +--rw shell-command?             string
      |  +--rw term-length?               uint16
      |  +--rw test-suite-file?           string
      |  +--rw time-rpcs?                 boolean
      |  +--rw time-rpcs-stats?           boolean
      |  +--rw time-rpcs-stats-file?      string
      |  +--rw uservars-file?             string
      |  +--rw use-rawxml?                boolean
      |  +--rw use-traceid?               boolean
      |  +--rw use-xmlheader?             boolean
      |  +--rw with-notif-commands?       boolean
      |  +--rw yangmap*                   string
      |  +--rw leaflist-multi-line?       boolean
      +--rw vars
      |  +--rw var* [name]
      |     +--rw name       nt:NcxName
      |     +--rw target?    string
      |     +--rw vartype?   YangcliVariableType
      |     +--rw value?     <anyxml>
      +--rw saved-devices
      |  +--rw device* [name]
      |     +--rw name           nt:NcxName
      |     +--rw devicetype?    string
      |     +--rw server         inet:host
      |     +--rw ncport?        uint16
      |     +--rw entry-point?   string
      |     +--rw protocols?     bits
      |     +--rw transport?     ywt:transport-type
      |     +--rw comment?       string
      +--rw saved-sessions
      |  +--rw session* [name]
      |  |  +--rw name                 nt:NcxName
      |  |  +--rw use-event-handler*   nt:NcxIdentifier
      |  |  +--rw device               nt:NcxDeviceName
      |  |  +--rw userid               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 server               inet:host
      |  |  +--rw ncport?              uint16
      |  |  +--rw entry-point?         string
      |  |  +--rw protocols?           bits
      |  |  +--rw transport?           ywt:transport-type
      |  |  +--rw start-commands
      |  |  +--rw vars
      |  |  |  +--rw var* [name]
      |  |  |     +--rw name       nt:NcxName
      |  |  |     +--rw target?    string
      |  |  |     +--rw vartype?   YangcliVariableType
      |  |  |     +--rw value?     <anyxml>
      |  |  +--rw comment?             string
      |  +--rw group* [name]
      |     +--rw name                  nt:NcxName
      |     +--rw session*              nt:NcxName
      |     +--rw missing-ok?           boolean
      |     +--rw missing-connect-ok?   boolean
      |     +--rw lost-ok?              boolean
      |     +--rw reconnect-tries?      uint32
      |     +--rw reconnect-interval?   uint32
      |     +--rw vars
      |        +--rw var* [name]
      |           +--rw name       nt:NcxName
      |           +--rw target?    string
      |           +--rw vartype?   YangcliVariableType
      |           +--rw value?     <anyxml>
      +--rw saved-schema-servers
      |  +--rw schema-server-id* [name]
      |     +--rw name         nt:NcxName
      |     +--rw user-id?     nt:NcxName
      |     +--rw device-id?   nt:NcxName
      +--rw saved-event-handlers
      |  +--rw eventid* [name]
      |     +--rw name            nt:NcxName
      |     +--rw module-name     nt:NcxName
      |     +--rw event-name      nt:NcxName
      |     +--rw script?         string
      |     +--rw shell-script?   string
      +--rw saved-users
      |  +--rw userid* [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 comment?             string
      +--rw do?                     string
      +--rw no?                     string
      +--rw apply?                  empty
      +--rw return?                 empty
      +--rw config-commit?          empty
      +--rw pipe
      |  +--rw begin?      string
      |  +--rw include*    string
      |  +--rw exclude*    string
      |  +--rw redirect?   string
      |  +--rw display?    enumeration
      +--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 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
        +---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
    

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
      +--rw yangdiff-pro
         +--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 yumapro-home?      string
         +--rw old?               nt:NcModuleSpec
         +--rw new?               nt:NcModuleSpec
         +--rw difftype?          DiffType
         +--rw output?            string
         +--rw header?            boolean
         +--rw home?              string
         +--rw subdirs?           boolean
    

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
      +--rw yangdump-pro
         +--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 feature-code-default?     enumeration
         +--rw feature-static*           yt:FeatureSpec
         +--rw feature-dynamic*          yt:FeatureSpec
         +--rw home?                     string
         +--rw yumapro-home?             string
         +--rw module*                   yt:NcModuleSpec
         +--rw subtree*                  yt:NcPathSpec
         +--rw deviation*                yt:NcModuleSpec
         +--rw output?                   string
         +--rw with-ocpattern?           boolean
         +--rw defnames?                 boolean
         +--rw doxygen-headers?          boolean
         +--rw force-prefix?             yt:NcxName
         +--rw format?                   FormatType
         +--rw modversion?               empty
         +--rw exports?                  empty
         +--rw dependencies?             empty
         +--rw identifiers?              empty
         +--rw html-div?                 boolean
         +--rw html-toc?                 TocType
         +--rw objview?                  ObjViewType
         +--rw quiet-mode?               empty
         +--rw short-names?              boolean
         +--rw show-errors?              empty
         +--rw lang-errors?              empty
         +--rw simurls?                  boolean
         +--rw sil-bundle?               yt:NcxName
         +--rw sil-include*              string
         +--rw (sil-edit)?
         |  x--:(sil-edit1)
         |  |  x--rw sil-edit1?          empty
         |  +--:(sil-edit2)
         |     +--rw sil-edit2?          empty
         +--rw (sil-get)?
         |  x--:(sil-get1)
         |  |  x--rw sil-get1?           empty
         |  +--:(sil-get2)
         |     +--rw sil-get2?           empty
         +--rw sil-nmda?                 empty
         +--rw sil-sa?                   empty
         +--rw subdirs?                  boolean
         +--rw (stats-report)?
         |  +--:(statistics)
         |     +--rw stats?              enumeration
         |     +--rw totals?             enumeration
         +--rw tree-identifiers?         empty
         +--rw unified?                  boolean
         +--rw urlstart?                 string
         +--rw versionnames?             boolean
         +--rw xsd-schemaloc?            string
    

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
    

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
    

yumaworks-callhome.yang

This module contains configuration data nodes to allow CallHome connections to be configured at run-time, in addition to the 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.

  • 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
    

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.

  • 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
    

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>
    

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

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
    

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.

  • 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 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
    

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>
    

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:

  • 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
    

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.

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
    

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
    

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
    

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
    

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
    

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-vendor?                     empty
         +--rw log-vendor-level?               yt:NcDebugType
         +--rw message-indent?                 int8
         +--rw yumapro-home?                   string
         +--rw loadpath?                       yt:NcPathList
         +--rw subdirs?                        boolean
         +--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
         +--rw create-empty-npcontainers?      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 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-sessions?                   uint16
         +--rw max-cli-sessions?               uint16
         +--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-status?                  boolean
         +--rw running-error?                  enumeration
         +--rw save-owners?                    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 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
         x--rw system-sorted?                  boolean
         +--rw target?                         enumeration
         +--rw tls-crl-missing-ok?             boolean
         +--rw tls-crl-mode?                   enumeration
         +--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 usexmlorder?                    empty
         +--rw (watcher-parm)?
         |  +--:(no-watcher)
         |  |  +--rw no-watcher?               empty
         |  +--:(watcher-interval)
         |     +--rw watcher-interval?         uint32
         +--rw wait-datastore-ready?           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-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-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-callhome?        boolean
         +--rw with-yumaworks-event-stream?    boolean
         +--rw with-yumaworks-ids?             boolean
         +--rw with-yumaworks-system?          boolean
         +--rw with-yumaworks-templates?       boolean
         +--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
    

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
    

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 /yctl:ycontrol/yctl:message-payload/yctl:payload/yctl:payload:
        +--rw sil-sa
           +--rw (message-type)
              +--:(config-request)
              |  +--rw config-request?             empty
              +--:(config-response)
              |  +--rw 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
              |     +--rw bundle*        yt:NcxName
              |     +--rw module*        yt:NcModuleSpec
              |     +--rw deviation*     yt:NcModuleSpec
              +--:(register-request)
              |  +--rw register-request
              |     +--rw bundle*                 yt:NcxName
              |     +--rw bundle-module*          yt:NcModuleSpec
              |     +--rw register* [module]
              |     |  +--rw module                   yt:NcxName
              |     |  +--rw path*                    string
              |     |  +--rw edit2-path*              string
              |     |  +--rw get-path*                string
              |     |  +--rw rpc-name*                yt:NcxName
              |     |  +--rw action-path*             string
              |     |  +--rw post-sethook-path*       string
              |     |  +--rw sethook-list* [hook-path]
              |     |  |  +--rw hook-path      string
              |     |  |  +--rw hook-format?   enumeration
              |     |  |  +--rw hook-type?     enumeration
              |     |  |  +--rw added-edit?    boolean
              |     |  +--rw transaction-hook-list* [hook-path]
              |     |  |  +--rw hook-path      string
              |     |  |  +--rw hook-format?   enumeration
              |     |  |  +--rw hook-type?     enumeration
              |     |  |  +--rw added-edit?    boolean
              |     |  +--rw stream-callback!
              |     |     +--rw (callback-type)?
              |     |        +--:(event-stream)
              |     |        |  +--rw event-stream?   ywt:NcxNumName
              |     |        +--:(all-streams)
              |     |           +--rw all-streams?    empty
              |     +--rw transaction-start?      empty
              |     +--rw transaction-complete?   empty
              |     +--rw validate-complete?      empty
              |     +--rw apply-complete?         empty
              |     +--rw commit-complete?        empty
              |     +--rw rollback-complete?      empty
              +--:(start-transaction)
              |  +--rw start-transaction
              |     +--rw transaction-id      string
              |     +--rw user-id             string
              |     +--rw client-addr?        string
              |     +--rw target              string
              |     +--rw validate?           boolean
              |     +--rw reverse-edit?       boolean
              |     +--rw load-config?        boolean
              |     +--rw is-hook-load?       boolean
              |     +--rw is-hook-validate?   boolean
              |     +--rw edit* [id]
              |        +--rw id             uint32
              |        +--rw operation      enumeration
              |        +--rw path           string
              |        +--rw hook-path?     string
              |        +--rw hook-format?   enumeration
              |        +--rw hook-type?     enumeration
              |        +--rw added-edit?    boolean
              |        +--rw editvars
              |        |  +--rw insert-op?          enumeration
              |        |  +--rw insert-str?         string
              |        |  +--rw insert-mode?        enumeration
              |        |  +--rw insert-val?         <anydata>
              |        |  +--rw sil-priority?       uint8
              |        |  +--rw operset?            empty
              |        |  +--rw move?               empty
              |        |  +--rw skip-sil-partial?   empty
              |        +--rw newval?        <anyxml>
              |        +--rw curval?        <anyxml>
              |        +--rw keys?          <anyxml>
              |        +--rw child-edit* []
              |           +--rw operation    enumeration
              |           +--rw editvars
              |           |  +--rw insert-op?          enumeration
              |           |  +--rw insert-str?         string
              |           |  +--rw insert-mode?        enumeration
              |           |  +--rw insert-val?         <anydata>
              |           |  +--rw sil-priority?       uint8
              |           |  +--rw operset?            empty
              |           |  +--rw move?               empty
              |           |  +--rw skip-sil-partial?   empty
              |           +--rw newval?      <anyxml>
              |           +--rw curval?      <anyxml>
              +--:(continue-transaction)
              |  +--rw continue-transaction
              |     +--rw transaction-id    string
              |     +--rw phase             enumeration
              +--:(transaction-response)
              |  +--rw transaction-response
              |     +--rw transaction-id    string
              |     +--rw added-edit* []
              |        +--rw path             string
              |        +--rw operation?       string
              |        +--rw where?           string
              |        +--rw point?           string
              |        +--rw skip-callback?   boolean
              |        +--rw edit?            <anyxml>
              +--:(cancel-transaction)
              |  +--rw cancel-transaction
              |     +--rw transaction-id    string
              +--:(trigger-replay)
              |  +--rw trigger-replay?             empty
              +--:(load-event)
              |  +--rw load-event
              |     +--rw 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
              |     +--rw bundle*        yt:NcxName
              |     +--rw module*        yt:NcModuleSpec
              |     +--rw deviation*     yt:NcModuleSpec
              +--:(bundle-load-event)
              |  +--rw bundle-load-event
              |     +--rw bundle*          yt:NcxName
              |     +--rw bundle-module*   yt:NcModuleSpec
              +--:(get-request)
              |  +--rw get-request
              |     +--rw transaction-id    string
              |     +--rw user-id?          string
              |     +--rw client-addr?      string
              |     +--rw flags?            bits
              |     +--rw max-entries?      uint32
              |     +--rw path              string
              |     +--rw keys?             <anyxml>
              |     +--rw matches?          <anyxml>
              |     +--rw select-nodes
              |        +--rw select-node* [objname]
              |           +--rw objname    string
              |           +--rw modname?   string
              +--:(get-response)
              |  +--rw get-response
              |     +--rw transaction-id         string
              |     +--rw more-data?             boolean
              |     +--rw match-test-done?       boolean
              |     +--rw active-case-modname?   string
              |     +--rw active-case?           string
              |     +--rw origin?                string
              |     +--rw (return-choice)?
              |        +--:(return-one)
              |        |  +--rw return-keys?     <anyxml>
              |        |  +--rw values?          <anyxml>
              |        +--:(return-getbulk)
              |           +--rw entry* []
              |              +--rw return-keys?   <anyxml>
              |              +--rw values?        <anyxml>
              +--:(notification)
              |  +--rw notification
              |     +--rw module-name    string
              |     +--rw event-name     string
              |     +--rw event-time     string
              |     +--rw stream-name?   yt:NcxName
              |     +--rw parms?         <anyxml>
              +--:(rpc-request)
              |  +--rw rpc-request
              |     +--rw transaction-id    string
              |     +--rw user-id?          string
              |     +--rw client-addr?      string
              |     +--rw rpc-module        yt:NcxName
              |     +--rw rpc-name          yt:NcxName
              |     +--rw rpc-input?        <anyxml>
              +--:(rpc-response)
              |  +--rw rpc-response
              |     +--rw transaction-id      string
              |     +--rw (response-type)?
              |        +--:(rpc-ok)
              |        |  +--rw rpc-ok?       empty
              |        +--:(rpc-output)
              |           +--rw rpc-output?   <anyxml>
              +--:(action-request)
              |  +--rw action-request
              |     +--rw transaction-id    string
              |     +--rw user-id?          string
              |     +--rw client-addr?      string
              |     +--rw path              string
              |     +--rw keys?             <anyxml>
              |     +--rw action-input?     <anyxml>
              +--:(action-response)
              |  +--rw action-response
              |     +--rw transaction-id         string
              |     +--rw (response-type)?
              |        +--:(action-ok)
              |        |  +--rw action-ok?       empty
              |        +--:(action-output)
              |           +--rw action-output?   <anyxml>
              +--:(trans-start-hook)
              |  +--rw trans-start-hook
              |     +--rw transaction-id    string
              |     +--rw user-id?          string
              |     +--rw client-addr?      string
              |     +--rw isvalidate?       boolean
              |     +--rw isrollback?       boolean
              |     +--rw isrunning?        boolean
              +--:(trans-complete-hook)
              |  +--rw trans-complete-hook
              |     +--rw transaction-id    string
              +--:(hook-get-request)
              |  +--rw hook-get-request
              |     +--rw path         string
              |     +--rw isrunning?   boolean
              +--:(hook-get-response)
              |  +--rw hook-get-response
              |     +--rw value?   <anyxml>
              +--:(stream-callback-event)
              |  +--rw stream-callback-event
              |     +--rw event-stream?      ywt:NcxNumName
              |     +--rw stream-subevent?   enumeration
              |     +--rw module-name?       yt:NcxName
              |     +--rw all-streams?       empty
              +--:(commit-completeness-hook)
                 +--rw commit-completeness-hook
                    +--rw transaction-id    string
                    +--rw user-id?          string
                    +--rw client-addr?      string
                    +--rw commit-phase?     enumeration
                    +--rw commit-type?      enumeration
    

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>
    

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
    

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
    

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
    

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 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>
    

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.

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
    

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
    

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 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
      +--rw ycontrol
         +--rw message-id       uint32
         +--rw message-type     enumeration
         +--rw server-id        union
         +--rw subsys-id        yt:NcxName
         +--rw service-id       union
         +--rw (message-payload)
            +--:(payload)
            |  +--rw payload
            |     +--rw shutdown-event?   empty
            +--:(ok)
            |  +--rw ok?        empty
            +--:(error)
               +--rw error
                  +--rw error-number      uint32
                  +--rw transaction-id?   string
                  +--rw error-message?    string
                  +--rw error-index?      uint32
    

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.

  • 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-gnmi.yang

  • YANG Tree:

    module: yumaworks-yp-gnmi
    
      augment /yctl:ycontrol/yctl:message-payload/yctl:payload/yctl:payload:
        +--rw yp-gnmi
           +--rw (message-type)
              +--:(config-request-case)
              |  +--rw config-request?        empty
              +--:(register-request-case)
              |  +--rw register-request?      empty
              +--:(config-response)
              |  +--rw config-response
              |     +--rw module*   yt:NcModuleSpec
              +--:(capability-request)
              |  +--rw capability-request
              |     +--rw extension*   union
              +--:(capability-response)
              |  +--rw capability-response
              |     +--rw supported-modules
              |     |  +--rw supported-modules* [name]
              |     |     +--rw name            string
              |     |     +--rw organization    string
              |     |     +--rw version         string
              |     +--rw supported-encodings?   supported-encoding
              |     +--rw gNMI-version?          string
              |     +--rw extension*             union
              +--:(get-request)
              |  +--rw get-request
              |     +--rw prefix?       string
              |     +--rw path*         string
              |     +--rw type?         enumeration
              |     +--rw encoding?     supported-encoding
              |     +--rw use-models
              |     |  +--rw supported-modules* [name]
              |     |     +--rw name            string
              |     |     +--rw organization    string
              |     |     +--rw version         string
              |     +--rw extension*    union
              +--:(get-response)
              |  +--rw get-response
              |     +--rw notifications
              |     |  +--rw notification* [timestamp]
              |     |     +--rw timestamp    string
              |     |     +--rw prefix?      string
              |     |     +--rw alias?       string
              |     |     +--rw update* [path]
              |     |     |  +--rw path           string
              |     |     |  +--rw typed-value?   string
              |     |     |  +--rw duplicates?    uint32
              |     |     +--rw delete*      string
              |     +--rw extension*       union
              +--:(set-request)
              |  +--rw set-request
              |     +--rw prefix?      string
              |     +--rw delete*      string
              |     +--rw replace
              |     |  +--rw update* [path]
              |     |     +--rw path           string
              |     |     +--rw typed-value?   string
              |     |     +--rw duplicates?    uint32
              |     +--rw update
              |     |  +--rw update* [path]
              |     |     +--rw path           string
              |     |     +--rw typed-value?   string
              |     |     +--rw duplicates?    uint32
              |     +--rw extension*   union
              +--:(set-response)
                 +--rw set-response
                    +--rw prefix?          string
                    +--rw timestamp?       string
                    +--rw update-result* [path op]
                    |  +--rw path      string
                    |  +--rw op        enumeration
                    |  +--rw status
                    |     +--rw code?      int32
                    |     +--rw message?   string
                    |     +--rw details?   string
                    +--rw extension*       union
    

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.

  • 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-grpc.yang

  • YANG Tree:

    module: yumaworks-yp-grpc
    
      augment /yctl:ycontrol/yctl:message-payload/yctl:payload/yctl:payload:
        +--rw yp-grpc
           +--rw (message-type)
              +--:(register-request-case)
              |  +--rw register-request?      empty
              +--:(capability-ad-event)
              |  +--rw capability-ad-event
              |     +--rw name       yang:yang-identifier
              |     +--rw address    inet:host
              |     +--rw port?      inet:port-number
              |     +--rw proto*     string
              |     +--rw service* [name]
              |        +--rw name      string
              |        +--rw method* [name]
              |           +--rw name                string
              |           +--rw client-streaming?   boolean
              |           +--rw server-streaming?   boolean
              +--:(open-stream-event)
              |  +--rw open-stream-event
              |     +--rw server-stream* [name]
              |     |  +--rw name        string
              |     |  +--rw location    inet:uri
              |     +--rw client-stream* [name]
              |        +--rw name        string
              |        +--rw location    inet:uri
              +--:(close-stream-event)
                 +--rw close-stream-event
                    +--rw server-stream*   string
                    +--rw client-stream*   string
    

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