Skip to main content

Provides a live view of network data within Nautobot.

Project description

Nautobot App Livedata



An App for Nautobot.

Overview

The Nautobot App LiveData is providing real-time data from network devices that are supported by Netmiko.

At the moment, the app is supporting only interface specific data. The data is collected from the devices via platform specific show commands and will be presented in the interface's 'Life Data' tab.

This app addresses the need for dynamic and up-to-date network information, allowing network administrators and engineers to make informed decisions based on the latest data.

Screenshots

  • Live Data Interface Output for interfaces

    Livedata output screenshot

  • Live Data Device Output for devices

    Livedata output screenshot

  • Configure the show commands to be executed on Platform level:

     Platform Screenshot

  • Job to clean up old data:

     Cleanup Job Results Screenshot

More screenshots can be found in the Using the App page in the documentation. Here's a quick overview of some of the app's added functionality:

Documentation

Full documentation for this App can be found over on the Nautobot-App-Livedtata Docs website:

Contributing to the Documentation

You can find all the Markdown source for the App documentation under the docs folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.

If you need to view the fully-generated documentation site, you can build it with MkDocs. A container hosting the documentation can be started using the invoke commands (details in the Development Environment Guide) on http://localhost:8001. Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.

Any PRs with fixes or improvements are very welcome!

Questions

For any questions or comments, please check the FAQ first. Feel free to also swing by the Network to Code Slack (channel #nautobot), sign up here if you don't have an account.

Support for Filter Commands in Live Device Output Using !! Syntax

Filter Syntax

You can now append a filter command to the end of a device command using the !! delimiter. The string following !! specifies the filter operation to be applied to the command output.

Examples

  • show logging | i {{intf_number}} !!EXACT:{{intf_number}}!! — Filters the output to contain only lines that contain the interface number as a whole word (e.g., matches Gi1/0/1, 1/0/1 , ^1/0/1 , 1/0/1$ but not 11/0/1, 1/0/11, foo1/0/1bar).
  • show logging !!LAST:100!! — Returns only the last 100 lines of the output.
  • show logging !!FIRST:10!! — Returns only the first 10 lines of the output.
  • show logging !!EXACT:{{intf_number}}!!FIRST:5!! — Filters for lines containing the interface number, then returns only the first 5 matching lines.

Supported Filters

  • !!EXACT:<pattern>!! — Only lines that contain <pattern> as a whole word (ignoring leading/trailing whitespace, not matching substrings within other numbers or words)
  • !!LAST:<N>!! — Only the last N lines
  • !!FIRST:<N>!! — Only the first N lines

Additional filters may be added in the future.

This feature provides a consistent filtering mechanism across all supported platforms, reducing the need for custom scripts or manual output parsing.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nautobot_app_livedata-2.4.4.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nautobot_app_livedata-2.4.4-py3-none-any.whl (2.7 MB view details)

Uploaded Python 3

File details

Details for the file nautobot_app_livedata-2.4.4.tar.gz.

File metadata

  • Download URL: nautobot_app_livedata-2.4.4.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nautobot_app_livedata-2.4.4.tar.gz
Algorithm Hash digest
SHA256 9b0b3495c57d89b3166ee14875390aa5b8aaa04100b50c193d80c94aa0804b04
MD5 03205ee5dfa42cb5f4e7235e6856c5d3
BLAKE2b-256 94ec5d9dadb34064eb18343df71f5027d63158c10f20649cd4f6f8c820ca555a

See more details on using hashes here.

File details

Details for the file nautobot_app_livedata-2.4.4-py3-none-any.whl.

File metadata

File hashes

Hashes for nautobot_app_livedata-2.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b4ace190cfbe796ca6103bbd1efd6837b5546a7c227eb6f4b06b42b4df01422b
MD5 2847a8c9aa0da188cda1a47399386934
BLAKE2b-256 5f3a492b8f433f6c6781859624db7748acf563abcb2495563edb7e654dab6209

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page