Overview

Welcome to the official documentation for the ydata Portal. This guide provides everything you need to know to leverage the portal’s powerful features and enhance your interaction with your Netbox Source of Truth.

What is the ydata Portal?

The ydata Portal is a high-performance web application that connects to your existing Netbox instance via its API. It’s not a replacement for Netbox but an intelligent business and operations layer built on top of it, designed to transform raw data into actionable insights.

  • For Engineers: Drastically reduce troubleshooting time with automated, end-to-end signal tracing and comprehensive datasheets for both devices and providers.
  • For Finance & Asset Managers: Bridge the gap between technical assets and financial data with powerful depreciation and lifecycle reporting tools.
  • For IT Management: Gain high-level oversight with automated monthly reports, KPI dashboards, and proactive EOL/EOS forecasting.

Core Features at a Glance

The portal is a suite of purpose-built tools. Here’s a quick look at what you can do:

  • Device Datasheet: Instantly generate a comprehensive, single-pane-of-glass view of any device, complete with automated end-to-end signal tracing for every port.

  • Provider Sheet: Get a complete operational view of any circuit provider, with all associated circuits and their physical paths automatically traced and visualized.

  • Site Dashboard: Get a bird’s-eye view of any datacenter site, with aggregated KPIs for space, power, assets, and connectivity.

  • Asset Depreciation: Correlate your live Netbox inventory with financial data from a simple CSV upload to calculate depreciation, run costs, and current book value.

  • Asset Lifecycle: Proactively manage hardware refreshes and support contracts with a centralized dashboard for all EOL/EOS dates and a visual forecast chart.

  • Device Type Catalog: Standardize your inventory by pushing curated, high-quality device types—complete with component templates, images, and lifecycle data—directly into your Netbox instance.

  • Changelog Explorer: Search and analyze your entire Netbox change history with powerful filters and at-a-glance statistics to understand who changed what, and when.

  • Monthly Reporting: Generate one-click summary reports for any month, visualizing key activity, growth trends, and top user contributions for management.

How to Use This Documentation

This site is structured to help you get started quickly and master each feature. We recommend following these steps:

  1. Start with the basics: The Getting Started guide will walk you through the initial connection to your Netbox instance.
  2. Understand access: The Instance & Access Management page explains how to manage multiple instances and the required Netbox permissions.
  3. Explore the features: Use the sidebar on the left to navigate to the detailed guide for any feature listed above. Each page provides step-by-step instructions, screenshots, and tips.