{"id":20588839,"url":"https://github.com/ciscodevnet/xr-gnmi-lab","last_synced_at":"2025-07-21T22:36:46.265Z","repository":{"id":76638862,"uuid":"234098001","full_name":"CiscoDevNet/xr-gnmi-lab","owner":"CiscoDevNet","description":"Understand gNMI and how to build your first gNMI client with Python to interwork with IOS-XR","archived":false,"fork":false,"pushed_at":"2023-07-11T14:18:18.000Z","size":262,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-22T17:35:05.782Z","etag":null,"topics":["cisco","cisco-ios-xr","gnmi","ios-xr","jupyter-notebook","yang"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CiscoDevNet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-15T14:27:24.000Z","updated_at":"2024-06-14T18:02:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"28cf3454-21fd-43fe-82e2-9e466acff0bb","html_url":"https://github.com/CiscoDevNet/xr-gnmi-lab","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CiscoDevNet/xr-gnmi-lab","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fxr-gnmi-lab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fxr-gnmi-lab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fxr-gnmi-lab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fxr-gnmi-lab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CiscoDevNet","download_url":"https://codeload.github.com/CiscoDevNet/xr-gnmi-lab/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CiscoDevNet%2Fxr-gnmi-lab/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266393620,"owners_count":23922424,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-21T11:47:31.412Z","response_time":64,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cisco","cisco-ios-xr","gnmi","ios-xr","jupyter-notebook","yang"],"created_at":"2024-11-16T07:26:42.954Z","updated_at":"2025-07-21T22:36:46.225Z","avatar_url":"https://github.com/CiscoDevNet.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# xr-gnmi-lab\n\n[![published](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-published.svg)](https://developer.cisco.com/codeexchange/github/repo/CiscoDevNet/xr-gnmi-lab) [![Run in Cisco Cloud IDE](https://static.production.devnetcloud.com/codeexchange/assets/images/devnet-runable-icon.svg)](https://developer.cisco.com/devenv/?id=devenv-vscode-base\u0026GITHUB_SOURCE_REPO=https://github.com/CiscoDevNet/xr-gnmi-lab)\n\n_Understand gNMI and how to build your first gNMI client with Python to interwork with IOS-XR_\n\n\u003cimg src=\"images/use case.png\"\u003e\n \n## Use Case Description\n\nThis laboratory comes with two Jupyter notebooks for practising the gNMI functionalities of Cisco IOS XR. A set of Docker containers is used for collecting and monitoring model-driven telemetry data. \n\n## Installation\n\n### Dependencies\n\n- Python 3\n- [Cisco-gnmi-python](https://github.com/cisco-ie/cisco-gnmi-python) library\n- Jupyter-notebook\n- Docker\n- Docker-compose\n- IOS XR\n\n### Configure\n\n1. Deploy the stack of containers for monitoring of telemetry data by following these [instructions](monitoring/README.md).\n\n2. Load the _Traffic Monitoring_ dashboard in Chronograf.\n\n\n## Configuration\n\nThe details for the connection and authentication to the IOS XR can be found in each notebook.\n\nThis laboratory assumes the following:\n\n- the host of the Jupyter notebook and the docker containers is `198.18.134.50`\n- the Jupyter notebook is exposed on port `8080`\n- the Chronograf web application is exposed on port `8888`\n- the IOS XR is reachable at `198.18.134.72` with username `cisco` and password `cisco`\n- the IOS XR has the following gRPC configuration:\n  ```\n  grpc\n   port 57777\n  !\n  ```\n\n## Usage\n\nAccess the notebook at https://198.18.134.50:8080.\n\nStart with the [`cisco-gNMI-main`](./cisco-gNMI-main.ipynb) notebook. To run a section of the laboratory, select the cell and press `Shift+Enter`.\n\n\n## How to test the software\n\nThis laboratory was tested in an environment that had the following software installed:\n\n| Software  | version |\n| ------------- | ------------- |\n| Python  | `3.6.8`  |\n| Cisco-gnmi  | `1.0.4` |\n| Jupyter-notebook | `6.0.2` |\n| Docker | `19.03.5` |\n| Docker-compose | `1.25.1` |\n| IOS XR | `7.0.x` |\n\n## Getting help\n\nIf you have questions, concerns, bug reports, etc., please create an issue against this repository.\n\n## Getting involved\n\nFeedback, bug fixes and feature enhancements or additions are encouraged. Please see the [CONTRIBUTING](./CONTRIBUTING.md) file for more information.\n\n## Author(s)\n\nThis project was written and is maintained by the following individuals:\n\n* cprecup \u003ccprecup@cisco.com\u003e\n* nckbgov \u003cnbelchug@cisco.com\u003e\n* sbyx \u003cstbarth@cisco.com\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciscodevnet%2Fxr-gnmi-lab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fciscodevnet%2Fxr-gnmi-lab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fciscodevnet%2Fxr-gnmi-lab/lists"}