Descrições de interface (API)
Além dos principais parâmetros de interfaces de rede, como nome, velocidade e modo de porta, o Apstra também configura uma descrição para interfaces físicas e interfaces lógicas agregadas (os chamados canais de porta). A descrição da interface é gerada automaticamente se as seguintes condições forem atendidas:
- A interface está conectada a um peer.
- A interface pertence ao leaf, spine ou sistema genérico.
- A interface peer pertence ao sistema leaf, spine ou genérico com endpoint de rede virtual neste servidor.
A descrição gerada tem o formulário <facing_|to.><peer-device-label>[:peer-interface-name]
. Exemplos:
- facing_spine2:Ethernet1/2
- to.server1:eth0
- to.server2
O prefixo do nome é facing_
se o peer for leaf, spine ou roteador externo. O prefixo é to.
no caso de um dispositivo peer ser um servidor L2 ou L3. A parte do nome da interface de peer só está presente quando o dispositivo peer é controlado pelo Apstra.
Apstra REST API — Descrições da interface
A API do Apstra é capaz de alterar a descrição da interface gerada automaticamente. No entanto, não existe essa funcionalidade na UI do Apstra.
A descrição da interface pode conter caracteres ASCII com códigos 33-126 e espaços, exceto "?", que é interpretado como uma conclusão de comando. O comprimento de descrição é limitado a 240 caracteres, que é o comprimento mais longo possível em modelos de switch suportados.
As interfaces são armazenadas internamente como nós gráficos com determinado conjunto de propriedades. A descrição é uma dessas propriedades. Para modificar a descrição, use a API genérica para interagir com nós gráficos.
- API — Obtenha a configuração da interface
- API — Crie ou modifique a descrição da interface
- API — Exclua a descrição da interface
API — Obtenha a configuração da interface
Para obter a configuração da interface, envie a solicitação GET para https://aos-server/api/blueprints/{blueprint-id}/nodes/{interface-node-id}.
Solicitação:
{ "description": "facing_dkl-2-leaf:Ethernet1/2", "mlag_id": null, "tags": null, "if_name": "swp2", "label": null, "port_channel_id": null, "ipv4_addr": "203.0.113.10/31", "mode": null, "if_type": "ip", "type": "interface", "id": "interface-id-1", "protocols": "ebgp" }
API — Crie ou modifique a descrição da interface
Para criar ou modificar a descrição da interface, envie uma solicitação de PATCH para https://aos-server/api/blueprints/{blueprint-id}/nodes/{interface-node-id} com um JSON válido. O JSON deve conter o campo "descrição" com dados válidos.
curl -X PATCH -H "AuthToken: EXAMPLE" \ -d '{"description": "New description I want!"}' http://aos-server:8888/api/blueprints/id-1/nodes/interface-id-1
Resposta:
{ "description": "New description I want!", "mlag_id": null, "tags": null, "if_name": null, "label": null, "port_channel_id": null, "ipv4_addr": null, "mode": null, "if_type": "ip", "type": "interface", "id": "interface-id-1", "protocols": "ebgp" }
API — Exclua a descrição da interface
Para excluir a descrição da interface personalizada e voltar à geração de descrição automática, defina a descrição para vazio de valor.
Solicitação:
curl -X PATCH -H "AuthToken: EXAMPLE" \ -d '{"description": ""}' http://aos-server:8888/api/blueprints/id-1/nodes/interface-id-1
Resposta:
{ "description": "", "mlag_id": null, "tags": null, "if_name": null, "label": null, "port_channel_id": null, "ipv4_addr": null, "mode": null, "if_type": "ip", "type": "interface", "id": "interface-id-1", "protocols": "ebgp" }
A solicitação get subseqüente mostrará que a descrição foi gerada automaticamente.
Solicitação:
curl -H "AuthToken: EXAMPLE" \ http://aos-server:8888/api/blueprints/id-1/nodes/interface-id-1
Resposta:
{ "description": "facing_dkl-2-leaf:Ethernet1/2", "mlag_id": null, "tags": null, "if_name": "swp2", "label": null, "port_channel_id": null, "ipv4_addr": "203.0.113.10/31", "mode": null, "if_type": "ip", "type": "interface", "id": "interface-id-1", "protocols": "ebgp" }