# Resolução de Problemas

Nesta capitulo, relacionaremos os principais elementos necessários para a resolução de problemas em uma rede.

# Técnicas de Troubleshooting - Um pouco de teoria...

#### **Definição**

Troubleshooting é o conjunto de ações orientadas à resolução de problemas na infraestrutura de redes, computadores, sistemas ou serviços correlatos. O seu único propósito é o de sanar o problema, restaurando assim o bom funcionamento do equipamento, rede, sistema ou serviço afetado, preferencialmente em tempo hábil e sem causar distúrbios adicionais para os usuários no decorrer do processo.

O troubleshooting consiste de ações de ***definição***, ***análise***, ***diagnóstico*** e ***reparo***, e fazendo isto devidamente com auxílio de processos, ferramentas e boas práticas.

#### **<span class="mw-headline" id="bkmrk-roteiro-recomendado--0">Roteiro recomendado de troubleshooting </span>**

Todo o processo é dividido em três fases primárias, denominadas ***Problema***, ***Diagnóstico*** e ***Solução***. Cada uma destas fases possui etapas, e cada uma destas etapas contém um conjunto de ações específicas para o tratamento e condução do suporte ao problema. O que será mostrado a seguir é uma expansão dos conceitos de cada fase.

- **Problema**

Nesta fase, o principal objetivo é a **<u>definição do problema</u>**. Como a dinâmica para surgimento de problemas envolve diversas possibilidades para cada caso, fica impraticável por muitas vezes corrigir um problema <u>sem</u> causar outros problemas, ou resolver o problema em <u>tempo hábil</u>. Uma coisa é certa: uma hora ou outra o problema será resolvido!

As questões aqui na verdade são:

**a)** ***<u>você conseguirá resolver o problema em tempo hábil, buscando minimizar os impactos para o negócio?</u>***

**b)** ***<u>você conseguirá resolver o problema sem causar distúrbios adicionais (graves ou não) para o ambiente?</u>***

Isto tudo pode ser evitado em grande parte através da correta definição do problema.

- **Diagnóstico**

Tão importante quanto definir o problema é saber diagnosticá-lo o mais precisamente possível. A proposta desta fase é <u>***conduzir diagnósticos efetivos***</u> alimentados pelas conclusões obtidas na fase "Problema" supracitada. Uma vez que você for capaz de compreender o problema com clareza (ou seja, defini-lo), você estará apto para iniciar o trabalho de coleta de informações e análises correspondentes com o intuito de identificar a causa-raiz e de completar o seu diagnóstico com maior clareza.

A qualidade da definição do problema impactará positiva ou negativamente o seu diagnóstico. Por onde começar o seu diagnóstico? Qual equipamento você acessará primeiro para coletar informações? Quais áreas funcionais da configuração e operação daquele equipamento deverão ser verificadas em primeira e segunda instâncias? Quais deverão ser as suas expectativas de comparação, contraste e constatação?

- **Solução**

Esta fase promoverá a correção do problema que:

<span style="text-decoration: underline;">**a) foi definido/compreendido corretamente,** </span>

<span style="text-decoration: underline;">**b) foi analisado e diagnosticado corretamente.**</span>

Na verdade, é mais que isso. Bem mais que isso. É resolver o problema com qualidade de ações, atitude e responsabilidade.

Esta fase constitui na correção do problema de forma mais cirúrgica, e não "*matar uma barata com bala de canhão*" como ocorre em muitos casos. Será nesta fase que você determinará o roteiro de correção do problema, as implicações e riscos associados com as manobras corretivas, ou seja, se a manobra de correção apresenta riscos de indisponibilidades parciais ou totais em caráter temporário, isto é, se haverá mais impacto ou não no ambiente para resolver aquele problema. E será nesta fase que você validará a necessidade de abertura de processo de Gestão de Mudança (GMUD) em caráter emergencial, se deverá haver um plano de comunicação com gestores e clientes, definir o plano de validação e *rollback*, dentre outras iniciativas.

#### **Abordagem detalhada**

Com base nas 3 etapas iniciais, iremos detalhar estes parâmetros para uma abordagem estruturada de Troubleshooting, conforme a imagem abaixo:

[![image-1608724099944.png](https://docs.ifsp.edu.br/uploads/images/gallery/2020-12/scaled-1680-/image-1608724099944.png)](https://docs.ifsp.edu.br/uploads/images/gallery/2020-12/image-1608724099944.png)

#### **<span class="mw-headline" id="bkmrk-etapas-da-fase-%22prob-0">Etapas da fase "Problema"</span>**

A parte mais crítica do processo de resolução de problemas ("troubleshooting") é a condução de uma análise adequada com o objetivo de definição do problema. Algumas sugestões de ações cabíveis neste estágio tão importante:

- ##### Descrição do Problema ("título")
    
    
    - Além de data e hora do surgimento do problema - quando o problema foi notado ou comunicado por usuários/clientes e/ou pela equipe de operação?
- ##### Escopo do Problema
    
    
    - Quais serviços da rede estão sendo afetados? Por exemplo: 
        - Wireless corporativo ou de convidados, acesso à Internet de usuários banda larga, acesso à Internet de usuários corporativos, acesso a websites ou serviços específicos, etc.
    - Fator de indisponibilidade associado ao problema: 
        - 100% indisponível?
        - Parcialmente indisponível?
        - Problema de natureza intermitente?
        - Lentidão apenas?
    - Locais afetados pelo problema: 
        - Prédios/sites, andares, departamentos/setores, sites, pops, e os usuários ou clientes espalhados nestes
        - Segmentos lógicos afetados, do conceito lógico do projeto 
            - VLANs específicas? Subredes específicas? Servidores específicos? Aplicações específicas?
            - Perímetros específicos, tais como usuários autenticados em um BNG/BRAS específico, usuários de um anel Metro, usuários atendidos por um roteador PE específico, etc.
- ##### Análise temporal do problema
    
    
    - Quando o problema surgiu pela primeira vez, isto é, quando a equipe de TI foi acionada?
    - Algum analista estava realizando alguma configuração ou modificação em algum equipamento da rede?
    - Há registros de mudanças recentes que coincidam com o surgimento do problema? (ex: revisão dos logs de TACACS+ ou registros internos de GMUD) 
        - Caso afirmativo, qual é a probabilidade de relevância das alterações que foram realizadas com o problema reportado? 
            - É factível considerar *rollback*, caso esta análise indique alta probabilidade.
    - É um problema recorrente, ou seja, ocorre com alguma frequência em sua rede?
    - Dentre outras iniciativas e questionamentos desta natureza.

Este pequeno roteiro embarca fatores tais como escopo *temporal* + *perímetro* + *qualitativo + quantitativo*, fomentando toda a lógica de análise preliminar e a devida <u>*compreensão do problema*</u>, ou seja, trazendo à tona todas as informações que você precisa saber para definir o problema! A qualidade das confirmações das situações e contextos acima ditará o seu grau de sucesso no troubleshooting nas etapas posteriores.

Isto é o que chamamos de ***Abordagem de Troubleshooting Estruturado.***

#### <span id="bkmrk--0"></span>**<span class="mw-headline" id="bkmrk-etapas-da-fase-%22diag-0">Etapas da fase "Diagnóstico"</span>**

Verifiquemos o roteiro esmiuçado e recomendado da fase Diagnóstico.

##### <span id="bkmrk--1"></span><span class="mw-headline" id="bkmrk-colete-informa%C3%A7%C3%B5es-0">Colete informações</span>

Com a definição do problema realizada com êxito, aqui você buscará coletar as informações necessárias para promover um diagnóstico efetivo do problema. Os equipamentos que você deverá acessar e as respectivas áreas funcionais a serem inspecionadas, enfim, tudo isto dependerá das informações obtidas durante a definição do problema. Já neste estágio, você deverá saber quais tecnologias (protocolos, serviços) deverão ser verificadas e em quais equipamentos você deverá conduzir estas verificações inicialmente.

Aqui você analisará logs, processos, CPU, memória, filas, buffers, interfaces, VLANs, tabelas MAC, ARP cache, vizinhanças/adjacências de protocolos de roteamento, estruturas de dados dos protocolos de roteamento, tabela de roteamento, ACLs, policies de BGP ou IGP, NAT, e tantos outros, mas <u>tudo aquilo e ***somente*** os componentes que tiverem relação ou conexão parcial ou total com a definição do problema</u>.

##### <span id="bkmrk--2"></span><span class="mw-headline" id="bkmrk-analise-as-informa%C3%A7%C3%B5-0">Analise as informações coletadas</span>

Na medida em que a coleta de informações vai desenrolando-se, você deverá traçar uma estratégia de análise para cada componente inspecionado. Em outras palavras, saber exatamente o que olhar e o que verificar em cada situação coletada. Isto inclui estado das interfaces, erros nas interfaces, configuração das interfaces (endereços IP, MTU, etc.), configurações e estados VLAN/802.1Q/STP/etc., configurações e estados de protocolos de roteamento (métricas, áreas, autenticações, políticas, filtros, adjacências, etc.), rotas na tabela de roteamento, serviços diversos e que por ventura se façam presentes (ex: port security, DHCP Snooping, DAI, IPSG, IP SLA, PBR, PPPoE, NAT, QoS/policy, o que for.. etc.), e assim por diante.

Obviamente isto exigirá bons conhecimentos sobre cada uma das tecnologias mantidas nas coletas que você realizou, como elas funcionam, como interagem, e quais são os requisitos de integração de cada uma destas tecnologias.

##### <span id="bkmrk--3"></span><span class="mw-headline" id="bkmrk-elimine-hip%C3%B3teses-0">Elimine hipóteses</span>

Das informações que você coletou, e após efetuar as análises preliminares, você deverá saber identificar o que certamente não contribui para o problema, ou o que não promoveu participação para o surgimento do problema.

O foco é o seguinte: tudo o que não for relacionado ao problema deverá ser desconsiderado.

A ideia aqui é fazer você ir ao campo de batalha com as armas necessárias apenas e com, no máximo, 3 possibilidades de ações visando a correção do problema. Além de levar muito mais tempo, é pouco efetivo, confunde, e pode causar outros e indesejáveis problemas, além de estresse emocional. Procure ser cirúrgico na hora de eliminar possibilidades, pois não adianta você encaminhar "10 possibilidades" para a fase de solução!

#### <span id="bkmrk--4"></span>**<span class="mw-headline" id="bkmrk-etapas-da-fase-%22solu-0">Etapas da fase "Solução"</span>**

Verifiquemos o roteiro esmiuçado e recomendado da fase Solução.

##### <span id="bkmrk--5"></span><span class="mw-headline" id="bkmrk-proponha-hip%C3%B3teses-0">Proponha hipóteses</span>

Em muitos casos você pode ter sido muito eficiente ou ter tido sorte, pois o problema foi fácil de diagnosticar! Isto é, você definiu bem o problema, fez as análises devidas, e, num piscar de olhos, conseguiu identificar a causa-raiz do problema!

No entanto, em muitos casos, poderão restar dúvidas, pois o diagnóstico do problema em questão talvez possa ser mais complexo e exigir mais conhecimentos por parte do analista, mas que, mesmo assim, você acredita que o problema esteja relacionado a duas ou três possibilidades, cujas interpretações são decorrentes da análise de informações e eliminação de hipóteses. Neste caso, a sugestão aqui é a de propor as hipóteses restantes devidamente classificadas por fidelidade (com o problema) versus o risco e esforço de implementação da correção.

Por exemplo, você tem duas hipóteses para resolver um determinado problema: uma delas, aparentemente a mais óbvia de ser o problema, mas que você não tem muita certeza ainda, exige uma manobra que provocará algum distúrbio na rede, tipo uma indisponibilidade. Já a segunda hipótese, menos provável de ser o problema, exige uma manobra corretiva mais rápida e que ainda apresenta zero risco para o negócio. Em razão disto, você poderá optar por aplicar a hipótese #2 e, caso não dê certo, fazer o *rollback,* e agendar a manobra necessária para a execução da hipótese #1, seja em caráter emergencial ou em horário apropriado, dependendo da urgência para o saneamento do problema no seu caso.

##### <span id="bkmrk--6"></span><span class="mw-headline" id="bkmrk-testar-hip%C3%B3teses-0">Testar hipóteses</span>

É exatamente aqui que você conduzirá as ações especificamente corretivas. Não saia mexendo em vários componentes de uma vez só! Seja organizado e tenha o controle absoluto da situação. Isto significa que você deverá implementar uma única ação corretiva (hipótese) por vez, sabendo que, em muitos casos, uma única hipótese poderá exigir a intervenção de uma ou mais tecnologias e em um ou mais equipamentos. Execute o procedimento com cautela, e faça as validações devidas para confirmar a correção do problema. Certifique-se que a manobra não tenha causado outros problemas (as vezes resolve “aquele” problema, mas pode afetar outras coisas na rede).

Não funcionou? Desfaça a alteração e implemente a próxima hipótese, ou, caso o problema não tenha sido corrigido, mas a correção (que não deu certo) é necessária mesmo assim, talvez esteja faltando conhecimentos para resolver o problema ou que talvez algum componente adicional tenha ficado de fora. Ou você (talvez) não tenha sido eficiente durante a coleta e análise de informações.

É a parte mais difícil de todo o processo de suporte, por isto que insisto que você seja bem efetivo nos estágios anteriores, justamente para atenuar a complexidade de compreensão, diagnóstico e correção do problema aqui, neste estágio.

##### <span class="mw-headline" id="bkmrk-problema-resolvido-0">Problema Resolvido</span>

Aqui você celebrará a resolução do problema! Aliás, não somente isto, aproveite a oportunidade para ***<u>documentar o problema e a solução empregada</u>***, e fazendo isto em uma base de conhecimentos que poderá servir para capacitar os times de suporte para que o problema em questão possa ser evitado futuramente, ou, caso haja nova ocorrência, ter a solução ou correção implementada em menor prazo e esforço.

#### **Referência:** 

[Abordagens para o Troubleshooting Eficaz de Problemas Típicos na Rede do ISP](https://wiki.brasilpeeringforum.org/w/Abordagens_para_o_Troubleshooting_Eficaz_de_Problemas_Tipicos_na_Rede_do_ISP)

# Levantamento de indicadores

Durante a tratativa de um problema, o primeiro e mais importante passo é o levantamento de indicios que permitam a identificação do problema.

Esses indicadores podem ser métricas ou registrod de eventos (logs).

#### Métricas

As métricas são valores de referencia em um determinado sistema (Ex,: Uso de CPU, numero de acessos a pagina, etc). Estes valores podem ser registrados através de sistemas de monitoramento de rede (NMS), como Zabbix, LibreNMS, Cacti, etc.

#### Registro de Eventos (Logs)

Os Logs são registros de eventos ocorridos em uma determinada aplicação ou sistema operacional. Estes logs podem ser encontrados em um local padrão (Ex.: /var/log, no caso do Linux) ou em locais especificados na configuração da aplicação.

# Topologia

O desenho da topologia de uma rede tem por objetivo criar um modelo visual da rede lógica da instituição.

Esta topologia permite as envolvidos em uma tratativa o alinhamento claro das ideias discutidas, e identificação de possiveis pontos de falha em uma rede.

Estes desenhos pode ser realizados em aplicações diversas, como: DIA UML, DrawIO, etc.

Abaixo colocamos o exemplo de 2 modelos presentes no DrawIO.

[![Topologia de Exemplo - B.png](https://manuais.ifsp.edu.br/uploads/images/gallery/2026-03/scaled-1680-/topologia-de-exemplo-b.png)](https://manuais.ifsp.edu.br/uploads/images/gallery/2026-03/topologia-de-exemplo-b.png)

[![Topologia de Exemplo - A.png](https://manuais.ifsp.edu.br/uploads/images/gallery/2026-03/scaled-1680-/topologia-de-exemplo-a.png)](https://manuais.ifsp.edu.br/uploads/images/gallery/2026-03/topologia-de-exemplo-a.png)

# Monitoramento



# Documentação de Rede - Atlas / Netbox

## Sumário

1. [Por quê documentar?](#bkmrk-1.-por-qu%C3%AA-documenta)
2. [O que é o NetBox](#bkmrk-2.-o-que-%C3%A9-o-netbox)
3. [Acesso ao Sistema](#bkmrk-3.-acesso-ao-sistema)
4. [Navegação Básica](#bkmrk-4.-navega%C3%A7%C3%A3o-b%C3%A1sica)
5. [Conceitos Importantes](#bkmrk-5.-conceitos-importa)
6. [O Tenant e as Permissões](#bkmrk-6.-o-tenant-e-as-per)
7. [Cadastro de Objetos por Módulo](#bkmrk-7.-cadastro-de-objet)
8. [Boas Práticas para os Campi](#bkmrk-8.-boas-pr%C3%A1ticas-par)
9. [Consultas e Filtros](#bkmrk-9.-consultas-e-filtr)
10. [Erros Comuns](#bkmrk-10.-erros-comuns)

---

## 1. Por quê documentar?

A documentação da rede é uma etapa fundamental para a perenidade de sua rede, uma vez que esta documentação favorece a analise e resolução de problemas.

Durante os anos a documentação da rede do IFSP passou por estágios de maturação, saindo da documentação da rede em planilhas e posteriormente em aplicações web espeficicas para este fim (Ex.: Racktables, Hub e Netbox).

Atualmente a aplicação responsavel por manter a uma documentação fidedigna da rede do IFSP é o Netbox, disponivel na URL [https://atlas.ifsp.edu.br](https://atlas.ifsp.edu.br)[.](https://atlas.ifsp.edu.br)

## 2. O que é o NetBox

O NetBox é uma[ aplicação web](https://netboxlabs.com/docs/netbox/) desenvolvida com o objetivo de funcionar como a **fonte de verdade** (Source of Truth) para:

- Endereçamento IP (prefixos, IPs, VRFs)
- Dispositivos de rede (switches, firewalls, APs, servidores)
- Racks e localização física
- Circuitos e provedores de internet
- VLANs
- Máquinas virtuais

Uma boa referencia, mostrando o Netbox desde a instalação até o seu uso foi apresentada na [Semana de Capacitação do Nic.br.](https://www.youtube.com/watch?v=_ooCL46Nqwc)

> **Regra de ouro:** Se está na rede, deve estar documentado no NetBox.

---

## 3. Acesso ao Sistema

### URL

```
https://atlas.ifsp.edu.br
```

### [![Atlas - RET.png](https://manuais.ifsp.edu.br/uploads/images/gallery/2026-03/scaled-1680-/atlas-ret.png)](https://manuais.ifsp.edu.br/uploads/images/gallery/2026-03/atlas-ret.png)

### Login

- Utilize seu **e-mail institucional** através do OAuth do Google.
- Cada usuário é associado à **CTI** do seu campus, a qual possui permissões restritas ao seu escopo.

### Permissões

O usuário só pode **criar, visualizar e alterar** objetos que estejam associados ao **Tenant do seu campus**. Por isso, ao cadastrar qualquer objeto no NetBox, é **obrigatório** selecionar o Tenant correto.

> **Exemplo:** Usuários da CTI do campus "Reitoria" só podem editar objetos cujo Tenant seja "Reitoria" (slug `ret`).

---

## 4. Navegação Básica

### Menu Principal

<table border="1" id="bkmrk-menu-o-que-cont%C3%A9m-or" style="border-collapse: collapse; border-style: solid;"><thead><tr><th>Menu</th><th>O que contém</th></tr></thead><tbody><tr><td>\*\*Organization\*\*</td><td>Sites, Tenants, Contacts</td></tr><tr><td>\*\*Devices\*\*</td><td>Devices, Racks, Device Types, Manufacturers</td></tr><tr><td>\*\*Connections\*\*</td><td>Cables, Interfaces</td></tr><tr><td>\*\*IPAM\*\*</td><td>Prefixes, IPs, VLANs, VRFs, ASNs</td></tr><tr><td>\*\*Circuits\*\*</td><td>Providers, Circuits</td></tr><tr><td>\*\*Virtualization\*\*</td><td>VMs, Clusters</td></tr></tbody></table>

### Barra de Pesquisa

Use a barra de pesquisa global (topo da tela) para encontrar qualquer objeto por nome, IP ou identificador.

### Filtros

Cada listagem possui filtros laterais. Use-os para localizar objetos do seu campus (filtre por **Site**, **Tenant** ou **Tag**).

---

## 5. Conceitos Importantes

### Hierarquia Física

```
Region → Site → Location → Rack → Device
```

<table border="1" id="bkmrk-conceito-no-ifsp-reg" style="border-collapse: collapse; border-style: solid;"><thead><tr><th>Conceito</th><th>No IFSP</th></tr></thead><tbody><tr><td>\*\*Region\*\*</td><td>Estado de São Paulo</td></tr><tr><td>\*\*Site\*\*</td><td>Campus (ex: Campus Reitoria)</td></tr><tr><td>\*\*Location\*\*</td><td>Sala/Andar (ex: Sala de Telecom Bloco A)</td></tr><tr><td>\*\*Rack\*\*</td><td>Rack físico (ex: Rack-01)</td></tr><tr><td>\*\*Device\*\*</td><td>Equipamento (ex: SW-CORE-RET-01)</td></tr></tbody></table>

### Hierarquia Lógica (IPAM)

```
VRF → Prefix → IP Address
VLAN Group → VLAN
```

### Tenant (Inquilino)

Identifica **quem é responsável** por um recurso. No nosso caso, cada campus é um tenant.

### Tag

Etiqueta para classificação adicional. Usamos tags com a sigla do campus (ex: `ARQ`, `BRT`, `CMP`).

---

## 6. O Tenant e as Permissões

### Como funciona o controle de acesso

No Atlas (NetBox do IFSP), as permissões de cada equipe são controladas pelo **Tenant** (inquilino). Cada campus possui um Tenant próprio, e o sistema utiliza o filtro `tenant__slug` nas regras de permissão para determinar o que cada usuário pode ver e editar.

```
Constraint de permissão:  { "tenant__slug": "ret" }
```

Isso significa que o usuário do campus RET só consegue visualizar e modificar objetos cujo Tenant tenha o slug `ret`.

> **Resumindo:** Se um objeto não estiver associado ao Tenant do seu campus, você **não terá acesso** a ele.

Ao cadastrar **qualquer objeto** no NetBox (device, rack, prefix, IP, VLAN, etc.), **obrigatoriamente selecione o Tenant do seu campus**. Se o campo Tenant ficar vazio ou com valor incorreto:

- Você poderá perder acesso ao objeto após salvar
- Outros membros da sua equipe não conseguirão visualizá-lo
- A equipe central (CAOTI) precisará intervir para corrigir

<p class="callout warning">REGRA FUNDAMENTAL: Sempre preencha o Tenant</p>

### O que é o Slug do Tenant?

O **slug** é o identificador interno do Tenant. Ele é definido em letras minúsculas, sem espaços ou acentos. Os slugs já estão configurados para cada campus — você **não precisa criá-los**, apenas **selecionar o Tenant correto** na lista suspensa ao cadastrar objetos.

**Exemplo:**

<table border="1" id="bkmrk-tenant-%28nome-exibido" style="border-collapse: collapse; border-style: solid;"><thead><tr><th>Tenant (nome exibido)</th><th>Slug (usado nas permissões)</th></tr></thead><tbody><tr><td>Araraquara</td><td>`arq`</td></tr><tr><td>Barretos</td><td>`brt`</td></tr><tr><td>Campinas</td><td>`cmp`</td></tr></tbody></table>

### Regras do Slug (para referência)

<table border="1" id="bkmrk-regra-exemplo-corret" style="width: 57.381%; height: 160.578px; border-collapse: collapse; border-style: solid;"><thead><tr style="height: 46.5938px;"><th style="width: 42.9929%; height: 46.5938px;">Regra</th><th style="width: 29.2162%; height: 46.5938px;">Exemplo Correto</th><th style="width: 27.791%; height: 46.5938px;">Exemplo Errado</th></tr></thead><tbody><tr style="height: 24.5938px;"><td style="width: 42.9929%; height: 24.5938px;">Somente letras minúsculas</td><td style="width: 29.2162%; height: 24.5938px;">`arq`</td><td style="width: 27.791%; height: 24.5938px;">`ARQ`</td></tr><tr style="height: 29.7969px;"><td style="width: 42.9929%; height: 29.7969px;">Sem espaços (use hífen)</td><td style="width: 29.2162%; height: 29.7969px;">`brt-a`</td><td style="width: 27.791%; height: 29.7969px;">`brt a`</td></tr><tr style="height: 29.7969px;"><td style="width: 42.9929%; height: 29.7969px;">Sem acentos</td><td style="width: 29.2162%; height: 29.7969px;">`hortolandia`</td><td style="width: 27.791%; height: 29.7969px;">`hortolândia`</td></tr><tr style="height: 29.7969px;"><td style="width: 42.9929%; height: 29.7969px;">Sem caracteres especiais</td><td style="width: 29.2162%; height: 29.7969px;">`brt-a`</td><td style="width: 27.791%; height: 29.7969px;">`brt/a`</td></tr></tbody></table>

### Na prática: como garantir que o Tenant está correto

1. Ao criar ou editar qualquer objeto, localize o campo **Tenant**
2. Selecione o nome do seu campus na lista suspensa
3. Se o campo já estiver preenchido com o Tenant correto, não altere
4. **Nunca** selecione o Tenant de outro campus

### Onde o Tenant deve ser preenchido

O campo Tenant está presente nos seguintes objetos:

- **Devices** (equipamentos)
- **Racks**
- **Sites**
- **Prefixes** (redes IP)
- **IP Addresses**
- **VLANs**
- **VLAN Groups**
- **Circuits**
- **Virtual Machines**
- **Clusters**

---

## 7. Cadastro de Objetos por Módulo

### 7.1 Devices (Equipamentos)

**Caminho:** Devices → Devices → + Add

<table border="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-exem" style="width: 67.9762%; height: 296.969px; border-collapse: collapse; border-style: solid;"><thead><tr style="height: 29.7969px;"><th style="width: 15.8932%; height: 29.7969px;">Campo</th><th style="width: 57.1011%; height: 29.7969px;">Descrição</th><th style="width: 26.8361%; height: 29.7969px;">Exemplo</th></tr></thead><tbody><tr style="height: 28.7969px;"><td style="width: 15.8932%; height: 28.7969px;">Name</td><td style="width: 57.1011%; height: 28.7969px;">Nome do equipamento (padrão de nomenclatura)</td><td style="width: 26.8361%; height: 28.7969px;">`SW-CORE-RET-01`</td></tr><tr style="height: 29.7969px;"><td style="width: 15.8932%; height: 29.7969px;">Device Role</td><td style="width: 57.1011%; height: 29.7969px;">Função do equipamento</td><td style="width: 26.8361%; height: 29.7969px;">Switch</td></tr><tr style="height: 29.7969px;"><td style="width: 15.8932%; height: 29.7969px;">Device Type</td><td style="width: 57.1011%; height: 29.7969px;">Modelo exato</td><td style="width: 26.8361%; height: 29.7969px;">Extreme X460-G2-48p</td></tr><tr style="height: 29.7969px;"><td style="width: 15.8932%; height: 29.7969px;">Site</td><td style="width: 57.1011%; height: 29.7969px;">Seu campus</td><td style="width: 26.8361%; height: 29.7969px;">Campus Reitoria (RET)</td></tr><tr style="height: 29.7969px;"><td style="width: 15.8932%; height: 29.7969px;">Location</td><td style="width: 57.1011%; height: 29.7969px;">Sala onde está</td><td style="width: 26.8361%; height: 29.7969px;">Telecom Bloco A</td></tr><tr style="height: 29.7969px;"><td style="width: 15.8932%; height: 29.7969px;">Rack</td><td style="width: 57.1011%; height: 29.7969px;">Rack onde está montado</td><td style="width: 26.8361%; height: 29.7969px;">Rack-01</td></tr><tr style="height: 29.7969px;"><td style="width: 15.8932%; height: 29.7969px;">Position</td><td style="width: 57.1011%; height: 29.7969px;">Posição U no rack (de baixo para cima)</td><td style="width: 26.8361%; height: 29.7969px;">20</td></tr><tr style="height: 29.7969px;"><td style="width: 15.8932%; height: 29.7969px;">Tenant</td><td style="width: 57.1011%; height: 29.7969px;">Seu campus</td><td style="width: 26.8361%; height: 29.7969px;">Reitoria</td></tr><tr style="height: 29.7969px;"><td style="width: 15.8932%; height: 29.7969px;">Tags</td><td style="width: 57.1011%; height: 29.7969px;">Adicione a tag do campus</td><td style="width: 26.8361%; height: 29.7969px;">RET</td></tr></tbody></table>

### 7.2 Racks

**Caminho:** Devices → Racks → + Add

<table border="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-exem-1" style="border-collapse: collapse; border-style: solid;"><thead><tr><th>Campo</th><th>Descrição</th><th>Exemplo</th></tr></thead><tbody><tr><td>Name</td><td>Identificação do rack</td><td>Rack-01</td></tr><tr><td>Site</td><td>Seu campus</td><td>Campus Reitoria (RET)</td></tr><tr><td>Location</td><td>Sala</td><td>Telecom Bloco A</td></tr><tr><td>Height</td><td>Altura em U</td><td>42</td></tr><tr><td>Tenant</td><td>Seu campus</td><td>Reitoria</td></tr><tr><td>Tags</td><td>Sigla do campus</td><td>RET</td></tr></tbody></table>

### 7.3 Prefixes (Redes IP)

**Caminho:** IPAM → Prefixes → + Add

<table border="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-exem-2" style="border-collapse: collapse; border-style: solid;"><thead><tr><th>Campo</th><th>Descrição</th><th>Exemplo</th></tr></thead><tbody><tr><td>Prefix</td><td>Rede no formato CIDR</td><td>10.100.10.0/24</td></tr><tr><td>VRF</td><td>Virtual Routing (veja tabela abaixo)</td><td>Rede Intracampus</td></tr><tr><td>Tenant</td><td>Seu campus</td><td>Reitoria</td></tr><tr><td>Site</td><td>Seu campus</td><td>Reitoria (RET)</td></tr><tr><td>Status</td><td>Estado atual</td><td>Active</td></tr><tr><td>Description</td><td>Descrição da rede</td><td>VLAN 10 - Administrativo</td></tr><tr><td>Tags</td><td>Sigla do campus</td><td>RET</td></tr></tbody></table>

**VRFs disponíveis:**

<table border="1" id="bkmrk-vrf-quando-usar-rede" style="border-collapse: collapse; border-style: solid;"><thead><tr><th>VRF</th><th>Quando usar</th></tr></thead><tbody><tr><td>Rede Intracampus</td><td>Redes internas do campus (10.x.x.x)</td></tr><tr><td>RNP</td><td>IPs fornecidos pela RNP (200.133.x.x)</td></tr><tr><td>WAN-\\\[Provedor\\\]</td><td>IPs de link do provedor</td></tr><tr><td>ASN-BGP</td><td>Blocos BGP do IFSP (não editar sem autorização)</td></tr><tr><td>AWS</td><td>VPCs na AWS (não editar sem autorização)</td></tr></tbody></table>

### 7.4 IP Addresses

**Caminho:** IPAM → IP Addresses → + Add

<table border="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-exem-3" style="width: 57.7381%; height: 268.172px; border-collapse: collapse; border-style: solid;"><thead><tr style="height: 29.7969px;"><th style="width: 18.5213%; height: 29.7969px;">Campo</th><th style="width: 44.7359%; height: 29.7969px;">Descrição</th><th style="width: 36.4915%; height: 29.7969px;">Exemplo</th></tr></thead><tbody><tr style="height: 29.7969px;"><td style="width: 18.5213%; height: 29.7969px;">Address</td><td style="width: 44.7359%; height: 29.7969px;">IP com máscara CIDR</td><td style="width: 36.4915%; height: 29.7969px;">10.100.50.1/24</td></tr><tr style="height: 29.7969px;"><td style="width: 18.5213%; height: 29.7969px;">VRF</td><td style="width: 44.7359%; height: 29.7969px;">Mesmo VRF do prefix pai</td><td style="width: 36.4915%; height: 29.7969px;">Rede Intracampus</td></tr><tr style="height: 29.7969px;"><td style="width: 18.5213%; height: 29.7969px;">Status</td><td style="width: 44.7359%; height: 29.7969px;">Active, Reserved, Deprecated</td><td style="width: 36.4915%; height: 29.7969px;">Active</td></tr><tr style="height: 29.7969px;"><td style="width: 18.5213%; height: 29.7969px;">DNS Name</td><td style="width: 44.7359%; height: 29.7969px;">FQDN se houver</td><td style="width: 36.4915%; height: 29.7969px;">fw-ret.ifsp.edu.br</td></tr><tr style="height: 29.7969px;"><td style="width: 18.5213%; height: 29.7969px;">Description</td><td style="width: 44.7359%; height: 29.7969px;">O que usa esse IP</td><td style="width: 36.4915%; height: 29.7969px;">Gateway VLAN Servidores</td></tr><tr style="height: 29.7969px;"><td style="width: 18.5213%; height: 29.7969px;">Tenant</td><td style="width: 44.7359%; height: 29.7969px;">Seu campus</td><td style="width: 36.4915%; height: 29.7969px;">Reitoria</td></tr><tr style="height: 29.7969px;"><td style="width: 18.5213%; height: 29.7969px;">Tags</td><td style="width: 44.7359%; height: 29.7969px;">Sigla</td><td style="width: 36.4915%; height: 29.7969px;">RET</td></tr><tr style="height: 29.7969px;"><td style="width: 18.5213%; height: 29.7969px;">Assigned to</td><td style="width: 44.7359%; height: 29.7969px;">Interface do device (se aplicável)</td><td style="width: 36.4915%; height: 29.7969px;">—</td></tr></tbody></table>

### 7.5 VLANs

**Caminho:** IPAM → VLANs → + Add

<table border="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-exem-4" style="border-collapse: collapse; border-style: solid;"><thead><tr><th>Campo</th><th>Descrição</th><th>Exemplo</th></tr></thead><tbody><tr><td>VLAN ID</td><td>Número da VLAN</td><td>10</td></tr><tr><td>Name</td><td>Nome descritivo</td><td>Administrativo</td></tr><tr><td>VLAN Group</td><td>Grupo do campus</td><td>RET</td></tr><tr><td>Site</td><td>Seu campus</td><td>Campus Reitoria (RET)</td></tr><tr><td>Tenant</td><td>Seu campus</td><td>Reitoria</td></tr><tr><td>Status</td><td>Active</td><td>Active</td></tr><tr><td>Tags</td><td>Sigla</td><td>RET</td></tr></tbody></table>

### 7.6 Cables (Cabeamento)

**Caminho:** Vá até a interface do device → clique em "Connect"

<table border="1" id="bkmrk-campo-descri%C3%A7%C3%A3o-exem-5" style="border-collapse: collapse; border-style: solid;"><thead><tr><th>Campo</th><th>Descrição</th><th>Exemplo</th></tr></thead><tbody><tr><td>Type</td><td>Tipo do cabo</td><td>CAT6a, SMF (fibra monomodo)</td></tr><tr><td>A Side</td><td>Interface de origem</td><td>SW-CORE-RET-01 → GigE 0/1</td></tr><tr><td>B Side</td><td>Interface de destino</td><td>FW-RET-01 → Port1</td></tr><tr><td>Status</td><td>Connected</td><td>Connected</td></tr><tr><td>Length</td><td>Comprimento (opcional)</td><td>3m</td></tr></tbody></table>

---

## 8. Boas Práticas para os Campi

### Nomenclatura de Devices

Use o padrão:

```
[TIPO]-[FUNÇÃO]-[CAMPUS]-[NÚMERO]
```

<table border="1" id="bkmrk-tipo-exemplos-sw-sw-" style="border-collapse: collapse; border-style: solid;"><thead><tr><th>Tipo</th><th>Exemplos</th></tr></thead><tbody><tr><td>SW</td><td>SW-CORE-PEP-01, SW-ACESSO-PEP-02</td></tr><tr><td>FW</td><td>FW-RET-01</td></tr><tr><td>AP</td><td>AP-RET-BLOCO-A-01</td></tr><tr><td>SRV</td><td>SRV-RET-01</td></tr></tbody></table>

### Checklist ao Cadastrar um Novo Equipamento

- [ ] Verificar se o Device Type já existe (não criar duplicado)
- [ ] Preencher Site, Location, Rack e Position
- [ ] Atribuir Tenant do campus
- [ ] Adicionar Tag com a sigla do campus
- [ ] Cadastrar as interfaces (se não vieram com o device type)
- [ ] Documentar IPs de gerência
- [ ] Conectar cabos entre interfaces

### Checklist ao Documentar uma Nova Rede

- [ ] Criar o Prefix no VRF correto
- [ ] Associar ao Tenant/Site do campus
- [ ] Criar a VLAN correspondente no VLAN Group do campus
- [ ] Cadastrar IPs relevantes (gateways, servidores)
- [ ] Adicionar Tag do campus

### O que NÃO fazer

- ❌ Não editar objetos de outros campi
- ❌ Não criar Device Types duplicados (pesquise antes)
- ❌ Não alterar VRFs, ASNs ou Aggregates (solicite ao CAOTI/NTI)
- ❌ Não deixar campos obrigatórios em branco
- ❌ Não usar slugs com letras maiúsculas ou caracteres especiais

---

## 9. Consultas e Filtros

### Encontrar todos os dispositivos do meu campus

1. Vá em **Devices → Devices**
2. No filtro lateral, selecione **Site** = seu campus
3. Ou filtre por **Tag** = sigla do campus

### Encontrar IPs disponíveis numa rede

1. Vá em **IPAM → Prefixes**
2. Clique no prefix desejado
3. Clique na aba **IP Addresses**
4. Os IPs livres serão mostrados com status "Available"

### Exportar dados

1. Em qualquer listagem, clique no botão **Export** (canto superior direito)
2. Escolha o formato: CSV, JSON ou YAML

### Usar a API

O NetBox possui uma API REST completa:

```
https://atlas.ifsp.edu.br/api/
```

Documentação interativa (Swagger):

```
https://atlas.ifsp.edu.br/api/docs/
```

---

## 10. Erros Comuns

<table border="1" id="bkmrk-erro-causa-solu%C3%A7%C3%A3o-%22" style="border-collapse: collapse; border-style: solid;"><thead><tr><th>Erro</th><th>Causa</th><th>Solução</th></tr></thead><tbody><tr><td>"A device with this name already exists"</td><td>Nome duplicado no mesmo site</td><td>Verifique se o device já foi cadastrado</td></tr><tr><td>"Duplicate IP address"</td><td>IP já cadastrado naquele VRF</td><td>Consulte quem está usando o IP</td></tr><tr><td>"This field is required"</td><td>Campo obrigatório vazio</td><td>Preencha todos os campos marcados com \\\*</td></tr><tr><td>"Invalid slug"</td><td>Slug com caracteres inválidos</td><td>Use apenas letras minúsculas, números e hífens</td></tr><tr><td>"Object not found" / Sem permissão</td><td>Tenant incorreto ou ausente no objeto</td><td>Edite o objeto e selecione o Tenant correto do seu campus</td></tr><tr><td>Não consigo ver meus objetos</td><td>Faltou o Tenant correto</td><td>Peça ao CAOTI/NTI para associar o Tenant ao objeto</td></tr><tr><td>Objeto sumiu após salvar</td><td>Salvou sem Tenant ou com Tenant errado</td><td>Contate o CAOTI/NTI para corrigir</td></tr></tbody></table>

---

## Suporte

Em caso de dúvidas ou problemas de acesso:

- **E-mail:** Contate a equipe CAOTI
- **Documentação oficial:** https://netboxlabs.com/docs/netbox/
- **API Docs:** [https://atlas.ifsp.edu.br/api/docs/](https://atlas.ifsp.edu.br/api/docs/)
- **Referencia:** [Semana de Capacitação Nic.br - Curso - Gerenciando a infraestrutura de maneira organizada com Netbox](https://www.youtube.com/watch?v=_ooCL46Nqwc)

---

*Documento elaborado pela equipe da CAOTI / DTI - IFSP com apoio de IA (Sonet 4.5)*