Ir para o conteúdo

NetBox SDK

Kit NetBox com foco no SDK para Python, terminal e UIs Textual.

O netbox-sdk é organizado em quatro pacotes irmãos:

  • netbox_sdk — SDK REST NetBox independente
  • netbox_cli — CLI com Typer
  • netbox_tui — TUI com Textual
  • netbox_mcp — servidor Model Context Protocol orientado por schema

O repositório expõe quatro superfícies públicas:

  • netbox_sdk para integrações Python
  • nbx para fluxos de CLI
  • várias TUIs Textual para navegação, depuração e execução guiada de comandos
  • nbx-mcp para acesso de agentes orientado por schema via stdio ou Streamable HTTP autenticado

O próprio pacote SDK expõe três camadas:

  • NetBoxApiClient para controle HTTP assíncrono de baixo nível
  • api() / Api para a camada de fachada assíncrona
  • typed_api() para o cliente tipado versionado com modelos Pydantic versionados

As linhas de release estáveis e tipadas atuais do SDK são NetBox 4.7, 4.6, 4.5, 4.4 e 4.3; o padrão usa o schema oficial GA v4.7.0. A integração contínua exercita a suíte live-NetBox contra v4.7.0, v4.6.6, v4.6.3, v4.6.2 e v4.5.10.

Versão documentada

Este site documenta o candidato de código-fonte netbox-sdk 0.0.13. A versão final mais recente no índice PyPI padrão é a 0.0.13; use ==0.0.13 para uma instalação reproduzível nesse índice.

  • SDK

    from netbox_sdk import api, typed_api

    Guia do SDK

  • CLI

    nbx dcim devices list
nbx dcim devices get --id 1

    Guia da CLI

  • TUI

    nbx tui
nbx demo tui --theme dracula

    Guia da TUI

  • MCP

    pip install 'netbox-sdk[mcp]'
nbx-mcp

    Guia do MCP

  • Início rápido

    pip install 'netbox-sdk[all]'
pip install 'netbox-sdk[all]==0.0.13'

nbx init
nbx dcim devices list

    Início rápido

Divisão do produto

  • A documentação do SDK cobre APIs Python importáveis, camadas de requisição, autenticação e clientes tipados versionados.
  • A documentação da CLI cobre a árvore de comandos nbx, comandos dinâmicos, GraphQL, perfil demo e exemplos de comandos capturados.
  • A documentação da TUI cobre o navegador principal, a bancada do desenvolvedor, o construtor de CLI, o visualizador de logs e o navegador de modelos Django.
  • A documentação do MCP cobre ferramentas, autenticação de transporte, segurança de mutações, resolução da linha de release e o bridge semântico de plugins.

Padrão para contribuidores

uv sync --dev --extra cli --extra tui --extra demo --extra mcp
uv run pre-commit install --hook-type pre-commit --hook-type pre-push
uv run pre-commit run --all-files
uv run pytest