▼YANG Library | Collection of modules supported by the server |
Module ietf-yang-schema-mount | YANG instrumentation library |
Module yumaworks-cert-usermap | YANG instrumentation library |
Module yumaworks-grpc-mon | YANG instrumentation library |
Module yumaworks-lock | YANG instrumentation library |
Module yumaworks-sm-yanglib | YANG instrumentation library |
Module yumaworks-yang-cbor | YANG instrumentation library |
▼libyumapro_agt | NETCONF Server message handler |
Agent Profile | The agent profile is used to store most of the configuration settings |
Agent Support for YANG Schema Mount | |
Agent Utilities | Contains many general utilities useful for SIL and SIL-SA code to use |
CLI and .conf File Parameters | CLI utilities to process the CLI parameters at boot-time |
►Configuration Edit Transactions | Configuration editing transaction management |
Configuration Edit Access Functions | Functions to manage the edit transaction |
Configuration Edit Data Structures | Data structures to manage edit transaction state |
Constants and Data Types | Constants and data types used for NETCONF and YANG details |
Core Agent Functions | Contains Library entry points and handles init and cleanup |
Global SIL callbacks | Global Server callbacks to integrate vendor instrumentation into the YANG module processing |
Library Mode | Handle Library mode if it is configured |
►Protocols | Server Protocol Handlers |
<ncx-connect> Handler | First message sent on an incoming connection from SSH and other protocols |
CBOR | Contains SID and LSID management for CBOR encoding |
DB-API | Database API for subsystems |
JSON | JSON Output Functions |
Load and Unload YANG | Load and unload SIL libraries at run-time |
►NETCONF | NETCONF protocol handler |
<get-support-save> Operation | The Support Save feature is used to gather server info for the vendor and YumaWorks technical support teams |
<hello> Message Handler | Processes the NETCONF <hello> message |
Call Home Support | CallHome allows the server to initiate the TCP connection to the client that is used for the NETCONF session |
Capabilities Handler | NETCONF protocol capabilities handler |
Configuration Templates | Configuration templates allow pre-configured YANG subtrees to be applied to incomplete edits to produce a complete subtree |
NETCONF Monitoring | YANG module ietf-netconf-monitoring implementation |
NETCONF Operations | Implements RFC 6241 protocol operations |
NMDA Support | NMDA protcol oprtations for NETCONF |
OpenSSL Support | NETCONF over TLS support using OpenSSL library APIs |
Partial Lock Operations | Partial Lock Operations from RFC 5717 |
RPC Error Handling | NETCONF RPC Error Handling |
Remote Procedure Call (RPC) | NETCONF Remote Procedure Call Support |
Time Filtered Retrieval | Retrieve data with 'if-modified-since' Time Filtering |
Yuma System Modules | Supports yuma-system and yumaworks-system modules |
YumaPro <get-bulk> Operation | <get-bulk> is used to iterate efficiently through a YANG list |
YumaPro Module Tag Filtering | YumaPro module tags implementation, if –with-modtags is true |
►Notifications | Client Notification Support for NETCONF and RESTCONF |
Data Structures | Supports original notifications (RFC 5277) using the <create-subscription> operation |
Event Filters | Implements yumaworks-event-filter module |
Event Streams | Implements yumaworks-event-stream module |
IETF Notifications | NETCONF base notifications |
Notification Control | Supports original notifications (RFC 5277) using the <create-subscription> operation |
YANG Push | YANG Push dynamic subscriptions are supported |
►RESTCONF | RESTCONF Protocol Support |
HTTP APIs for RESTCONF | HTTP APIs for RESTCONF Protocol Support |
Protocol Message Handler | RESTCONF protocol operation support |
RESTCONF over CoAP | Experimental Unsupported CoAP/UDP transport for RESTCONF |
Reply Handler | RESTCONF Reply Handler |
►SNMP | Server interface to net-snmp agent for SNMP support |
AgentX | AgentX interface for Server interface to net-snmp agent for SNMP support |
Core Functions | Control interface for Server interface to net-snmp agent for SNMP support |
Notifications | Notification interface for net-snmp agent for SNMP support |
Protocol Support | Protocol support for net-snmp agent for SNMP support |
Security Support | Security support for net-snmp agent for SNMP support |
Utility Functions | Utility functions for net-snmp agent for SNMP support |
Subtree Filtering | Subtree Filtering used by NETCONF and RESTCONF Operations |
XML | XML Message Processing Support |
XPath Filtering | XPath Filtering used by NETCONF and RESTCONF Operations |
YANG Actions | YANG actions are like RPC handlers embedded within YANG data |
YANG Library | The YANG Library contains conformance information that reflects the modules, features, and deviations loaded into the server |
YANG Patch | YANG Patch server implementation |
YANG Validation | YANG Validation control and instrumentation callbacks |
YANG-API and DB-API Support | YANG-API and DB-API message support |
YControl | YControl protocol is used by services between the main server and subsystems |
YP-GNMI | YumaPro gNMI implementation integrated into the server |
YP-GRPC | YumaPro gRPC implementation integrated into the server |
►YP-HA | Service layer for High Availability (YP-HA) |
YP-HA Active Server | Handle Active Server YP-HA role |
YP-HA Control | Service layer for High Availability (YP-HA) |
YP-HA Standby Server | Handle Standby Server YP-HA role |
libcurl Support | Libcurl is used to support the NETCONF :url capability |
►SIL and SIL-SA Callbacks | Server callbacks to integrate vendor instrumentation into the YANG module processing |
Commit Complete Callback | Commit Complete Callbacks allow SIL or SIL-SA code to be invoked when an edit transaction is completed |
Core Functions | Core callbacks and hooks used in the server |
Data Structures | Macros and data structures used to manage YANG instrumentation callbacks and hooks |
GET2 | GET2 callback handler |
Hook Utilities | This file contains functions to support validation of callbacks and some supplemental functions |
SIL Library | SIL Load and Unload Library Support |
SIL Transaction APIs | SIL Transactions are initiated from the main server |
Timer Services | Server Timer Callback with 1 second tick |
Unload Library Support | SIL and SIL-SA callback support during unload operations |
YANG Validation Callbacks | Handle YANG validation callbacks for SIL and SIL-SA code |
►Security Features | YUMA-NACM is obsolete and not supported |
ACM Wrapper Access Functions | The ACM manager allows NACM or a vendor-specific ACM to be installed |
Audit Log Support | The Audit Log Manager generates events for the security audit log |
Encrypted Password Management | IANA crypt-hash and openconfig-hashed-value Password Support |
External ACM Model | The External ACM handler provides the required access control APIs outside of the server control |
IETF ACM Model (NACM) | The NACM handler provides the required access control APIs within the server |
►Sessions | NCX server sessions allow clients and subsystems to connect to the server |
Session Control | Server sessions are allocated in order connect request received |
Session and IO Handling | NCX server provides sockets and receives IO from sessions |
Signal Handler | Processess software interrupts from the operating system |
yp-system Library | The optional yp-system library provides system-wide vendor hooks into the server |
▼libyumapro_db-api | Subsystem support for the DB-API protocol |
DB-API Data Types | DB-API data types are used only by the db_api.c C code |
DB-API Functions | DB-API functions are used in the db-api-app and combo-app |
▼libyumapro_ncx | NCX Module Library Utility Functions |
Global Callbacks | Initialize and cleanup the Global Callbacks |
►Logging | System logging access functions |
Logging Functions | Configure logging and write to the various logging streams |
Logging Types | Contains the System log level enumeration |
SYSLOG | System logging access functions using SYSLOG protocol |
Test Log Level Macros | Logging macro definitions |
Vendor Logging | This is the vendor API type for receiving log messages from YumaPro |
NCX Data Structures | C Data Structures used to represent YANG module constructs |
NCX Error Codes | Error code definitions–be sure to add any err code definitions to the copy in err.c to register the errcode name, the error severity, and the error string |
►NCX Library Global Data | Module static data in ncx.c |
Generic Object Templates | Generic objects to construct generic output data in the server |
Global Variables | Static module defined variables maintained in ncx.c There are access APIs for each parameter |
NCX Global Constants | NCX Global Constants used in compiler, server, and yangcli-pro |
►NCX Utilities | Utlities for application layer to use |
Binary Data Utilities | Base64 utility functions for YANG |
►CLI Utilities | Command Line Interface and Text Configuration File Support |
CLI Parser | Bootstrap CLI based on name/value pairs Used to setup the basics as soon as possible |
CLI Run Stack Support | A stack of CLI contexts |
CLI Variables | Management of a hierarchy of (name, value) pairs |
Help Support | Use YANG object metadata to generate help text for CLI |
Debugging Utilities | Internal Heap Checking |
Definition Registry | Provides fast tiered lookup for data structures used to process NCX messages |
Double Linked Queues | Linear queues used throughout the system (dlq_hdr_t) |
Error Handling Support | Default error messages and other error reporting support functions |
File Utilities | Wrappers to standard Linux file system APIs |
General NCX Utilities | General utlities to support the server implementation |
NCX Back Pointers | General Utility to store a back pointer to another pointer |
Posix Threads | Posix threads support for server and client |
String / Enum Conversions | Convert between enumeration and string for log output |
Timestamp Utilities | Timestamp and time format conversion functions |
►Protocols | Protocol support functions |
►CBOR | CBOR Processing |
CBOR Output Functions | CBOR output to a session control block or a file |
CBOR Parser | YANG and other namespaces maintained in a registry |
LSID | Support Experimental YANG to CBOR SID File |
SID Management | Support Experimental YANG to CBOR SID File |
YANG SID Dictionary | Schema Item Identifier assignment mapping dictionary |
YANG SID File | Support YANG to CBOR SID File |
GET2 Callback Support | NCX Data Model Get Operation callback handler for virtual data that is not stored in a val_value_t tree |
Get Bulk Support | Supports the NETCONF <get-bulk> operation |
JSON | Contains JSON parsing and output utilities |
NCX TCP Support | TCP Support for Non-Blocking Connect |
NETCONF Capabilities | The capabilities module constructs two versions |
NETCONF Configuration Datastores | Configuration segments are stored in sequential order |
NETCONF Operations | Partial lock can only be used if –target=running It does not allow multiple threads to edit at once |
NMDA Support | Make sure to include "ncx_nmda.h" and "ncx_owner.h" to use the ncx_owner APIs |
Protocol Message State | Protocol independent message processessing state |
►RESTCONF Support | RESTCONF protocol support |
RESTCONF Core Functions | RESTCONF Core Functions |
RESTCONF Data Structures | RESTCONF Data Structures |
RPC Error Support | Support for <rpc-error> messages |
Remote Procedure Call (RPC) | NETCONF <rpc> Request and <rpc-reply> Response Messages |
SNMP | Manages AVL tree of SMIv2 OID to YANG object mappings |
►Schema Mount Support | Schema Mount support |
Schema Mount Core Functions | Schema Mount Core Functions |
►Session Support | Handles all inbound and outbound network sessions |
Core Session Support Functions | Core Functions to manage, read, and write sessions |
Session Data Structures | Macros and data structures used for session management |
Session Message Support | Session messages are used by sessions and stored in ses_msg_t |
►Value Nodes (val_value_t) | A value node (val_value_t) represents an instance of a YANG object |
List Key Map for GETNEXT Support | Key Map provides a YANG row cache to automate the processing of GET2 callback parameters to setup the next entry |
Value Node Child Access Support | Manages the storage and access of child nodes within a YANG container or list instance |
Value Node Core Functions | Core data access functions to create and use YANG data |
Value Node Macros | Constants and macros used to manage YANG data nodes |
Value Node Types | Data types used to store YANG data values |
Value Node Utility Functions | High level value node utility functions |
►XML Support | XML Processing |
Top XML Message Dispatch | Top Message Dispatch via XML Text Reader |
XML Namespace Support | YANG and other namespaces maintained in a registry |
XML Output Functions | XML output to a session control block or a file |
XML Parser | YANG and other namespaces maintained in a registry |
XML Utilities | XML Write Utilities |
XML Value Node Utilities | Older XML utilities to make low-level data structures Most high level functions can use val_util APIs instead |
►YANG Data Support | Used to access YANG instance data for protocol messages, used within the client or server |
User Defined Data Types | User defined types allow SIL code (not SIL-SA code) to provide type handlers |
YANG Number (ncx_num_t) | Make sure to include "ncxtypes.h" and "ncx_num.h" to use the ncx_num APIs |
YANG Simple List (ncx_list_t) | NCX Lists are simple string based lists |
YANG String (ncx_str_t) | Make sure to include "ncxtypes.h" and "ncx_str.h" to use the ncx_str APIs |
YANG Patch Media Type | YANG Patch Support (RFC 8072) |
YANG Validation Support | Process some YANG validation statements, such as unique-stmt |
YP-gNMI Support | GNMI Get and Set support |
►XPath Support | XPath 1.0 filtering and YANG validation |
XPath Core Functions | XPath Parser Support Functions |
XPath Data Structures | Internal data structures used for XPath evaluation |
XPath1 Parser | XPath 1.0 parser implementation used by multiple programs |
XPath1 Result Support | XPath 1.0 Expression Result Data Structure Support |
XPath1 Server AIO Support | All-in-One API callback support for XPath 1.0 Processing |
XPath1 Server GET2 Support | GET2 API callback support for XPath 1.0 Processing |
►YANG | YANG 1.1 Data Modeling Language |
►YANG Compiler | Multi-program YANG compiler |
Compiler Token Processing | Convert YANG files and other syntaxes into a queue of tokens |
General Compiler Support | General YANG compiler support functions Lower level functions to process YANG statements |
YANG Compiler Error Messages | Handle compiler error messages |
YANG Constants | YANG constants |
YANG Identifiers | YANG Identifier validation functions |
►YANG Parser Support | XML and CBOR Parser Utilities |
Parser Utilities | YANG Parser Control Block and General Access Functions |
►YANG Type Definitions | Type definitions for leaf and leaf-list data nodes |
Core Functions for YANG Types | APIs to access compiler data strctures during compilation |
Parser Functions for YANG Types | YANG Parser functions to consume and resolve data types |
YANG Type Data Structures | Data structures for YANG type implementation |
YANG XPath Support | YANG Specific XPath Expression Handling |
YIN Language Format | YIN Language Format |
►YANG Data Structures | Internal structures representing YANG module constructs |
External Statement (ncx_appinfo_t) | NCX appinfo is used to store YANG external statements |
External yang-data structures | Support 'yang-data' extension defined in RFC 8040 |
General Data Structures | General YANG module data structures |
YANG Binary Data (ncx_binary_t) | Binary data handling functions |
YANG Bit Statement (ncx_bit_t) | YANG bit statement handling |
YANG Deviation | YANG deviation statement handling |
YANG Enum Statement (ncx_enum_t) | Enumeration data type handling |
YANG Error Info (ncx_errinfo_t) | NETCONF and YANG error reporting support |
YANG Extension Statement (ext_template_t) | Support YANG Module parser extension statement |
YANG Feature Statement | Support YANG Module parser feature statement |
YANG Identity Statement (ncx_identity_t) | -YANG identity statement support |
YANG Import Statement (ncx_import_t) | YANG import statement processing |
YANG Include Statement (ncx_include_t) | YANG include statement processing |
►YANG Objects | YANG Schema Nodes are store in obj_template_t structures |
Experimental Object Dictionary | Old experimental code for RESTCONF over CoAP not enabled |
Object Access Functions | Object access functions allow the compiler to create an object template tree |
YANG Object Parsing | Support YANG data definition statements |
YANG Object Types | The YANG object template is used to represent every possible YANG data definition construct |
YANG Type Name (ncx_typname_t) | YANG type name support |
YANG grouping statement (grp_template_t) | Support YANG Module parser grouping statement |
►YANG Library | Registry of modules supported by the server implementation |
►Configuration | Configure Internal YANG Library Properties |
Module Queues | The modules loaded into a YANG library are represented by queues |
Settings | Settings to control YANG warnings |
User Callbacks | Callbacks are registered by the server to handle events related to loading and unloading YANG modules from the YANG Library |
Search the YANG Library | Manage queues of ncx_module_t_ data stuctures |
YANG Library Status | Check if any module errors occurred when loading the library Check for module errors after modules are loaded |
►YANG Module | Access module properties and data definitions |
Get YANG Module Properties | Get module properties and access fields within the ncx_module_t_ data structure |
Load a YANG Module | YANG modules are loaded into the client and server |
Search a YANG Module | Search functions for the ncx_module_t_ structure Find top-level constructs like rpc, data, notifications |
YANG Module Utilities | Actions and configuration setting utilities for the ncx_module_t data structure |
▼libyumapro_sil-sa | Subsystem support for the SIL-SA protocol |
Agent Profile | The agent profile message is received from the server and processed into a local copy of the agt_profile_t structure |
Callback Functions | SIL-SA callback functions are written for specific YANG objects |
Core Functions | SIL-SA core functions are used to manage the subagent role in the distributed server |
Data Structures | SIL-SA data structures are used to manage the YANG instrumentation subsystem state within the distributed server |
Transaction Hooks | Transaction hooks allow advanced access to an edit transaction |
▼libyumapro_subsys-pro | Thin client subsystem used to connect to the NCX socket for communications with the main server |
Core Functions | Subsystem core functions are used to launch the subsystem and perform IO operations |
Utility Functions | Subsystem utility functions are used to provide support functions to implement the subsystem |
▼libyumapro_ycontrol | Subsystem support for the YControl protocol |
Core Functions | YControl core functions are used by the application to control and integrate with the YControl protocol handler |
Data Structures | YControl data structures are used to manage communications state with the main server, and higher level service layers that register as a YControl service |
Input Output Functions | YControl IO handler will create a connection and session to the main server |
Message Parsing | YControl message parsing supports XML encoded communications between the main server and a subsystem |
Message Send APIs | YControl message send APIs are used to send any of the subsystem message types to the main server |
Message Utilities | YControl message utilities are used internally to construct messages to the main server and receive messages from the main server |
Sessions | YControl session handler will create and manage session control blocks for the subsystem |
Signal Handler | YControl session handler will create and manage session control blocks for the subsystem |