NetBox plugin to document data flows between systems and applications.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for Alef-Burzmali from gravatar.com Alef-Burzmali

Unverified details

These details have not been verified by PyPI
Meta
  • License Expression: Apache-2.0
    SPDX License Expression
  • Author: Thomas Fargeix
  • Tags netbox , netbox-plugins
  • Requires: Python >=3.12
Classifiers
Report project as malware

Project description

NetBox Data Flows Plugin

NetBox plugin to document Data Flows between devices and applications.

Features

  • Document data flows between IP addresses, IP ranges and Prefixes documented in NetBox.
  • Regroup the data flows into applications and hierarchical groups.

Documenting your data flows can help you design the network architecture, automate your firewall rule definition or reviews, implement security contracts in a software-defined network, or respond to compliance requirements.

Screenshots

Data Flow

Representation of a data flow A data flow for an application, here representing the user access to frontend servers and backend servers over TCP/443.

Targets of a data flow Details of the data flow specifications, displaying all the IP addresses, IP ranges and Prefixes that are involved in that data flow.

Application

All the data flows mapped to one application The application allows you to group all the related data flows. Optionally, you can assign devices or other NetBox objects to an application, using a custom field.

Device tab views

List of data flows involving a VM The plugin adds Tab views to Devices, Virtual Machines, IP addresses, IP ranges and Prefixes to list all the data flows that involve them as a source or destination.

Getting started

Read the Quick Start tutorial to discover how to use the plugin.

Data model

The data model and design's decisions can be found in the documentation.

Installation and configuration

Instructions to install, configure, update or uninstall the plugin can be found in the plugin's documentation.

Supported Versions

netbox version netbox-data-flows version
>= 4.5.0 >= v1.4.1
>= 4.4.0 >= v1.2.1, < v1.5.0
>= 4.3.0 >= v1.1.1, < v1.5.0

Older versions

Only the latest version of the plugin is officially supported. The test suite is run on the latest patch version of the current version of NetBox, and the previous one (if no breaking compatibility change).

Dependencies

  • NetBox
  • Python 3.12 or higher

Contributions

Contributions are welcomed. This plugin is developped on the free time of its author, so do not expect regular releases.

Please report security vulnerabilities via GitHub security advisory. Do not create a public issue. See also the Security Policy.

Please report bugs and feature requests in GitHub.

GitHub Discussions are opened for general help requests and any other topics you may want to discuss.

Known bugs and limitations

  • GraphQL API is not implemented

See also the list of issues.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for Alef-Burzmali from gravatar.com Alef-Burzmali

Unverified details

These details have not been verified by PyPI
Meta
  • License Expression: Apache-2.0
    SPDX License Expression
  • Author: Thomas Fargeix
  • Tags netbox , netbox-plugins
  • Requires: Python >=3.12
Classifiers

Release history Release notifications | RSS feed

This version

1.5.0

1.4.1

1.4.0

1.3.0

1.2.1

1.2.0

1.1.1

1.1.0

1.0.6

1.0.5

1.0.4

1.0.3

1.0.1

1.0.0

0.9.0

0.8.3

0.8.2

0.8.0

0.7.4

0.7.3

0.7.2

0.7.1

0.7.0

0.6.0

0.5.2

0.5.0

Download files

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

Source Distribution

netbox_data_flows-1.5.0.tar.gz (3.4 MB view details)

Uploaded Source

Built Distribution

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

netbox_data_flows-1.5.0-py3-none-any.whl (79.2 kB view details)

Uploaded Python 3

File details

Details for the file netbox_data_flows-1.5.0.tar.gz.

File metadata

  • Download URL: netbox_data_flows-1.5.0.tar.gz
  • Upload date:
  • Size: 3.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for netbox_data_flows-1.5.0.tar.gz
Algorithm Hash digest
SHA256 ad67e2fbb7c739b8472215b5bc85c47298e1fb63edb6a233ff4900d7c9bb9554
MD5 ef9531e4ab1d0b871e43a1fdc581e932
BLAKE2b-256 7c0b988523589df722d57ff8e6aa96398f14670ce12cd976a8deedebb5c5598d

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_data_flows-1.5.0.tar.gz:

Publisher: publish-pypi.yml on Alef-Burzmali/netbox-data-flows

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file netbox_data_flows-1.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_data_flows-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 916520b72f7c7bf7fe9dbbbf3e62aebe4ef1fd4fc616f8abaa5dfe5e2b1d0e47
MD5 cc2b15ddede999ba40936970ffc434d3
BLAKE2b-256 c29df2f061c0a8bb2d03c2adc6e860f84ff0ad68e66ccd592e52b414d61896f8

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_data_flows-1.5.0-py3-none-any.whl:

Publisher: publish-pypi.yml on Alef-Burzmali/netbox-data-flows

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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