NetFlow and sFlow Configuration Guide on Cisco 8000 Series Routers, Cisco IOS XR Releases

PDF

NetFlow and sFlow Configuration Guide on Cisco 8000 Series Routers, Cisco IOS XR Releases

Access data models

Want to summarize with AI?

Log in

Explains the available options for accessing data models and describes their configuration context.


An access data model is a configuration mode that

  • describes the supported behavior and operating context

  • identifies relevant configuration, support, or operational details, and

  • helps users understand when and how to apply the feature.

Options for accessing data models

Describes the available options for accessing data models and their organizational structure.

A data model is a structured representation that defines how data is organized, accessed, and managed in a system.

You can access data models using one of these options:

  • Directly through the system interface

  • By using APIs provided by the platform

  • Through downloadable model files for offline analysis


Access data models from the router

Accessing data models from the router enables remote configuration and management using NETCONF and YANG, allowing you to view supported data models for your software version.

  • Facilitates remote device management and configuration.

  • Allows you to retrieve and examine YANG data model capabilities.

You can configure the router to provide access to YANG data models using the NETCONF protocol. This enables remote configuration and management of the device and allows you to view supported data models for your software version.

NETCONF provides a standardized interface for interacting with YANG data models on Cisco routers.

  • Use NETCONF to automate device configuration and retrieve model information.

Procedure

1.

Enter global configuration mode.

Example:

Router# configure
          

Global configuration mode allows you to make changes to the router's settings.

  • Ensure you have the necessary privileges to access configuration mode.

If...

Then...

You are not in privileged EXEC mode

Enter 'enable' to access privileged EXEC mode before configuring.

You do not have configuration privileges

Contact your administrator for access rights.

You are already in global configuration mode

Proceed to the next step.

You are now in global configuration mode and can configure NETCONF.

2.

Configure the NETCONF network management protocol to enable remote configuration and management using YANG data models.

Example:

Router(config)# netconf-yang agent ssh
          

This command enables NETCONF over SSH, allowing secure remote access to YANG data models.

  • Ensure SSH is enabled and accessible on the router.

If...

Then...

SSH is not enabled

Enable SSH before configuring NETCONF.

NETCONF is already enabled

Verify configuration or proceed to commit changes.

Configuration fails

Check for syntax errors or missing prerequisites.

NETCONF is enabled for remote management using YANG data models.

3.

Commit the configuration.

Example:

Router(config)# commit
          

Committing saves the configuration changes to the router.

  • Ensure all changes are correct before committing.

If...

Then...

Configuration is valid

Changes are applied successfully.

Configuration is invalid

Review error messages and correct configuration.

Commit fails

Check for system errors or insufficient privileges.

Configuration changes are committed to the router.

4.

Establish a NETCONF session with the device and retrieve the capabilities information.

Example:

Router# show netconf-yang capabilities
Tue Sep 19 22:03:26.305 UTC
[Netconf capabilities]

   D: Has deviations

 Capability                                                                       | Revision |D
----------------------------------------------------------------------------------+----------+-
urn:ietf:params:netconf:base:1.1                                                  | -        | 
urn:ietf:params:netconf:capability:candidate:1.0                                  | -        | 
urn:ietf:params:netconf:capability:confirmed-commit:1.1                           | -        | 
urn:ietf:params:netconf:capability:interleave:1.0                                 | -        | 
urn:ietf:params:netconf:capability:notification:1.0                               | -        | 
urn:ietf:params:netconf:capability:rollback-on-error:1.0                          | -        | 
urn:ietf:params:netconf:capability:validate:1.1                                   | -        | 
http://cisco.com/ns/yang/Cisco-IOS-XR-8000-fib-platform-cfg                       |2019-04-05| 
http://cisco.com/ns/yang/Cisco-IOS-XR-8000-lpts-oper                              |2022-05-05| 
http://cisco.com/ns/yang/Cisco-IOS-XR-8000-platforms-npu-resources-oper           |2020-10-07| 
http://cisco.com/ns/yang/Cisco-IOS-XR-8000-qos-oper                               |2021-06-28| 
http://cisco.com/ns/yang/Cisco-IOS-XR-Ethernet-SPAN-act                           |2021-03-22| 
http://cisco.com/ns/yang/Cisco-IOS-XR-Ethernet-SPAN-cfg                           |2022-07-13| 
http://cisco.com/ns/yang/Cisco-IOS-XR-Ethernet-SPAN-datatypes                     |2021-10-06| 
http://cisco.com/ns/yang/Cisco-IOS-XR-Ethernet-SPAN-oper                          |2022-09-05| 
http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-aaacore-cfg                             |2019-04-05| 
http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-ldapd-cfg                               |2022-06-22| 
http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-ldapd-oper                              |2022-05-20| 
http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-lib-cfg                                 |2020-10-22| 
http://cisco.com/ns/yang/Cisco-IOS-XR-aaa-lib-datatypes 
----------------------------------   Truncated for brevity  --------------------------------------

By examining the capabilities, you can view the available data models for the software version installed on the router.

  • Use the output to determine which YANG models are supported.

If...

Then...

The capabilities list includes desired YANG models

You can proceed with configuration using those models.

Some YANG models are missing

Check software version or contact Cisco support for model availability.

Capabilities output is empty

Verify NETCONF configuration and session status.

You have retrieved the NETCONF YANG capabilities and can view supported data models.

Once completed, NETCONF is enabled and you can remotely access and view YANG data model capabilities for your router's software version.

What to do next

Review the retrieved YANG data models to ensure compatibility with your intended configuration and management tasks.

  • Update device configuration as needed based on available YANG models.


Access data models from Cisco Feature Navigator

Access and download YANG data models for Cisco IOS XR releases using Cisco Feature Navigator.

  • View, filter, and export YANG data models for automation and integration tasks.

Cisco Feature Navigator provides regularly updated YANG data models for Cisco IOS XR releases. The platform allows you to search, filter, and download models for automation and integration. If you encounter issues or have suggestions, use the feedback link provided on the site.

Data models are organized by type: Cisco XR native models, Unified models, and OpenConfig models. The visual tree structure helps you understand relationships between modules, containers, leaves, and leaf lists.

  • Use filters to narrow down data model definitions by platform, release, and node status (deprecated, obsolete, unsupported).

Before you begin

Ensure you have access to Cisco Feature Navigator. A Cisco.com account is optional but allows for additional features.

  • Optional: Cisco.com account credentials for enhanced access.

Follow these steps to access data models from Cisco Feature Navigator.

Procedure

1.

Go to Cisco Feature Navigator.

Example:

N/A

N/A

If...

Then...

You have a Cisco.com account

Log in with your credentials for enhanced access.

You do not have a Cisco.com account

Continue as guest.

N/A

N/A

N/A

2.

If you have a Cisco.com account, log in with your credentials. If you do not have an account, continue as guest.

Example:

N/A

You are directed to the Cisco Feature Navigator main page.

If...

Then...

You log in with Cisco.com account

You access additional features.

You continue as guest

You access basic features.

N/A

N/A

N/A

3.

Select YANG Data Models.

Example:

N/A

N/A

If...

Then...

N/A

N/A

N/A

N/A

N/A

N/A

N/A

4.

Select the Product and Cisco IOS XR Release based on your requirement.

Example:

N/A

The data models are listed by type: Cisco XR native models, Unified models, and OpenConfig models.

  • Use the search field to find a specific data model.

If...

Then...

You select product and release

Data models are listed by type.

You use search field

You find specific data model.

N/A

N/A

N/A

5.

Click the data model of interest to view more details.

Example:

N/A

The data model displays in a hierarchical tree structure, making it easier to navigate and understand the relationships between YANG modules, containers, leaves, and leaf lists. Apply filters to narrow down the data model definitions for the selected platform and release based on status such as deprecated, obsolete, and unsupported nodes.

  • Click the Download icon to export the data model information in Excel format.

  • This visual tree form helps you get insights into the nodes you can use to automate your network.

  • The data models on Cisco Feature Navigator are regularly updated based on IOS XR release. If you encounter any problems or have suggestions for improvements, share your experience using the Send us your feedback link.

If...

Then...

You click Download icon

Data model information is exported in Excel format.

You use filters

Data model definitions are narrowed by platform, release, and node status.

You use feedback link

You can share your experience or suggestions.

N/A

You can view, filter, and download YANG data models for Cisco IOS XR releases from Cisco Feature Navigator.

What to do next

N/A


Access data models from GitHub

Access Cisco IOS XR data models from the GitHub repository by browsing release folders and downloading YANG files as needed.

  • Obtain the latest and historical data models for IOS XR releases.

  • Download YANG files for specific releases and features.

  • Contribute to the repository or review deviations and supported sensor paths.

The GitHub repository for Cisco IOS XR data models provides folders organized by release, allowing users to access, review, and download YANG files for each supported release.

The repository is regularly updated and includes documentation for supported and unsupported sensor paths, as well as opportunities for community contributions.

  • Use the repository to find data models for specific IOS XR releases.

  • Review the Available-Content.md file for a comprehensive list of supported data models.

Before you begin

Ensure you have internet access and a web browser to access the GitHub repository.

  • Optional: Create a GitHub account if you plan to contribute or open issues.

Follow these steps to access data models from GitHub.

Procedure

1.

Go to the GitHub repository for Cisco IOS XR data models.

Example:

N/A

The repository page lists folders based on IOS XR releases.

  • Each folder corresponds to a specific IOS XR release version.

If...

Then...

You want data models for a specific IOS XR release

Navigate to the corresponding release folder.

You need to review supported sensor paths

Check the Available-Content.md file or relevant YANG files.

You want to contribute or report an issue

Submit a pull request or open an issue in the repository.

The repository page displays folders for each IOS XR release.

2.

Navigate to the release folder of interest to view the list of supported data models and their definitions. For example, to access data models for IOS XR release 7.10.1, click the folder named 7.10.1.

Example:

N/A

Each folder contains YANG files representing different data models.

  • Folders are named according to IOS XR release versions.

  • YANG files define models or augment existing models with additional XPaths.

If...

Then...

You want to see all supported data models for a release

Review the Available-Content.md file in the folder.

You need details about supported sensor paths

Check the openconfig-acl.yang file.

You want to see unsupported sensor paths

Review the cisco-xr-openconfig-acl-deviations.yang file.

The release folder displays YANG files and documentation for supported and unsupported sensor paths.

3.

Click the YANG file you want to access to view its contents.

Example:

N/A

You can click the Raw button to see the raw code or use the Download button to download the file to your computer.

  • Each data model defines a complete and cohesive model or augments an existing data model with additional XPaths.

  • Unsupported sensor paths are documented as deviations.

If...

Then...

You want to view the contents of a YANG file

Click the file and use the Raw or Download button.

You need to review deviations for unsupported sensor paths

Open the cisco-xr-openconfig-acl-deviations.yang file.

You want to see a comprehensive list of supported data models

Navigate to the Available-Content.md file in the repository.

The YANG file contents are displayed, and you can download the file as needed.

4.

Repeat these steps for other versions or data models of interest.

Example:

N/A

The GitHub repository for IOS XR data models is regularly updated based on release. You can contribute to the repository by submitting pull requests or opening issues if you encounter problems or have suggestions for improvements.

  • Repository updates may include new releases, features, or corrections.

  • Community contributions help improve the repository and documentation.

If...

Then...

You want to access data models for another release

Navigate to the desired release folder and repeat the steps.

You want to contribute or report an issue

Submit a pull request or open an issue in the repository.

You need to stay updated on new releases

Monitor the repository for updates and new folders.

You can access and download data models for multiple IOS XR releases and contribute to the repository as needed.

You can access, review, and download Cisco IOS XR data models from the GitHub repository for any supported release. The repository provides comprehensive documentation and opportunities for community contributions.

What to do next

Monitor the repository for updates and new releases. Contribute to the repository or open issues as needed.

  • Review downloaded YANG files for compatibility with your IOS XR deployment.