Welcome to Cisco YANG Suite!
============================

YANG Suite is a set of tools related to YANG models (`RFC 6020`_, `RFC 7950`_)
and related technologies such as NETCONF (`RFC 6241`_).

It provides a modular infrastructure which various YANG application plugins
can be used.

Please check developer.cisco.com/yangsuite for information, learning labs, and announcements.

Getting Started
---------------

If this is your first time running YANG Suite, you have two ways to begin:

1. Configure YANG Suite to connect to a device (router or switch) "Setup --> Device profile" and then
   download supported YANG models from the device at "Setup --> YANG files and repositories".
2. Upload YANG model files from your computer to YANG Suite at "Setup --> YANG files and repositories".

Once you have provided YANG models to YANG Suite by either of the above
methods, you can then proceed to define sets of YANG models of interest at "Setup --> YANG module sets".

Once this is done you can proceed to learn how to explore the contents of these YANG models at "Explore --> YANG",
or use these models to send NETCONF at "Protocols --> NETCONF".

For more information on any of these topics, use the table of contents
or the search box, both on the right side of this page.
To return to this page at any time, use the "Help" menu in the
sidebar to the left of any YANG Suite page. For page-specific help,
click the ``(?)`` icon in the top right corner.

About YANG Suite
----------------

The core application plugins for YANG Suite are:

yangsuite-filemanager
  Manages storage of YANG schema files within the application.
  Allows users to upload YANG schema files to the application.

yangsuite-devices
  Manages device profile definitions and access to devices.

yangsuite-yangtree
  Provides basic browsing of YANG models in a tree format.

yangsuite-netconf
  Download supported YANG models from a device,
  construct and send NETCONF (`RFC 6241`_) RPCs to a device.

User Administration
-------------------

From the menu bar at the top of any YANG Suite page,
select "Admin → Manage users".
In the page that loads, you can manage users
and groups to access the YANG Suite server.

Troubleshooting
---------------

You can browse the server logs generated by YANG Suite by selecting
"Admin → View logs".

If you face any issues, checkout developer.cisco.com/yangsuite.
To provide feedback, email us at yangsuite-support-ext@cisco.com.

.. _`RFC 6020`: https://tools.ietf.org/html/rfc6020
.. _`RFC 6241`: https://tools.ietf.org/html/rfc6241
.. _`RFC 7950`: https://tools.ietf.org/html/rfc7950
