Ir para o conteúdo

CLI

nbx é a interface de linha de comando do NetBox SDK. Compartilha configuração, descoberta de esquema e lógica de requisição com o SDK Python e a camada TUI.

Há quatro modos complementares de interação:

Modo Exemplo Quando usar
Dinâmico nbx dcim devices list Operações do dia a dia — auto-descoberto via OpenAPI
HTTP explícito nbx call GET /api/status/ Caminhos personalizados, exploração em massa da API
Descoberta nbx groups / nbx resources dcim Aprender o que está disponível
GraphQL nbx graphql "{ sites { name } }" Consultas entre recursos e experimentação de esquema

Visão geral da árvore de comandos

nbx
├── init                    configura o perfil default
├── config                  mostra a configuração atual
├── groups                  lista todos os grupos de app OpenAPI
├── resources GROUP         lista recursos de um grupo
├── ops GROUP RESOURCE      lista operações de um recurso
├── graphql                 executa consultas GraphQL
├── call METHOD PATH        requisição HTTP explícita
├── tui                     lança o navegador Textual principal
├── logs                    mostra logs estruturados recentes da aplicação
├── cli                     auxiliares específicos da CLI
│   └── tui                 lança o construtor de comandos guiado
├── docs                    ferramentas de geração de documentação
│   └── generate-capture    captura saída da CLI em docs/generated/
├── demo                    perfil demo.netbox.dev
│   ├── init                autentica em demo.netbox.dev
│   ├── config              mostra config do perfil demo
│   ├── reset               remove credenciais demo salvas
│   ├── tui                 lança TUI com perfil demo
│   ├── cli                 construtor de comandos no perfil demo
│   │   └── tui             construtor guiado no perfil demo
│   ├── dev                 ferramentas de desenvolvedor no perfil demo
│   │   ├── tui             lança Dev TUI no perfil demo
│   │   └── django-model    inspeciona modelos Django do NetBox
│   └── <group> <resource>  mesma árvore da raiz, usando perfil demo
├── dev                     ferramentas de desenvolvedor e interfaces experimentais
│   ├── tui                 lança bancada de requisições do desenvolvedor
│   ├── http                auxiliares HTTP diretos para caminhos arbitrários da API
│   └── django-model        montar/buscar/navegar modelos Django do NetBox
└── <group>                 grupo de app OpenAPI (dcim, ipam, …)
    └── <resource>          recurso (devices, prefixes, …)
        ├── list            endpoint GET de lista
        ├── get             endpoint GET de detalhe (requer --id)
        ├── create          POST
        ├── update          PUT (requer --id)
        ├── patch           PATCH (requer --id)
        └── delete          DELETE (requer --id)