API de Configuração - Adicionando, Atualizando, e Removendo staticHost

Recomendamos fortemente que antes de começar a usar a API Cato, revise a Política de Suporte para a API Cato.

Este artigo explica como usar a API Cato para gerenciar hosts definidos para um site com esses comandos:

addStaticHost
updateStaticHost
removeStaticHost

Visão geral de staticHost

Use as APIs de mutação staticHost para adicionar, atualizar e remover hosts de um site na sua conta e definir as seguintes configurações para o host:

Nome do Host
Endereço IP do host
Endereço MAC (opcional - usado para reservar uma atribuição de IP DHCP para o host)

Para contas de revendedor, você pode criar chaves de API separadas dentro de cada conta de cliente que está configurando as configurações com a API Cato.

Localizando a siteID de um Site

O ID do site não é mostrado na Aplicação de Gerenciamento Cato, você pode localizar o ID do site:

Usando a consulta API entityLookup (veja Cato API - EntityLookup), use o tipo com o valor site

Você também pode usar o parâmetro search com o valor como o nome do site, e a consulta retorna o ID do site
Número na URL para a Aplicação de Gerenciamento Cato, quando você selecionou um site (Network > Sites > {site name}). Por exemplo, o ID do site é 12345 para a seguinte URL: https://cc.catonetworks.com/#/26/sites/12345/networkAnalytics

Detalhes para os Argumentos addStaticHost e updateStaticHost

Os mesmos argumentos são usados para criar ou atualizar um host por trás de um site usando a API de configuração Cato. Para addStaticHost, os argumentos são obrigatórios a menos que marcado como opcional. Para updateStaticHost, inclua os argumentos para as configurações do host que você está atualizando.

hostId - Para updateStaticHost, insira o ID do host que você está atualizando

Para addStaticHost, esse ID é gerado quando o novo host é criado
nome - Nome do Host atrás do site
ip - Endereço IP do host atrás do site
macAddress - (opcional) Endereço MAC do host atrás do site

O endereço MAC do host é usado para reserva DHCP para hosts com endereço IP estático

StaticHost hostId

O hostId é o ID interno Cato para a entidade do host.

O networkRangeId pode ser recuperado usando a API de leitura entityLookup, use o tipo com o valor host

StaticHost nome

Use o argumento nome para definir o Nome do Host.

StaticHost ip

Use o argumento ip para definir o endereço IP do host.

StaticHost macAddress (Opcional)

Use o argumento macAddress para definir o endereço MAC do host para reserva DHCP.

Para contas que usam Cato como o servidor DHCP, o endereço IP dos hosts definidos com um endereço MAC é reservado e não pode ser atribuído a um host diferente. Certifique-se de que o endereço IP para o host não esteja dentro da faixa DHCP para um segmento de rede definido para o site.

removeStaticHost

Use a API removeStaticHost para deletar um host que está definido para um site. Você só precisa usar o hostId com esta API.

Script de Exemplo do Postman

mutation addStaticHost ($accountId: ID!, $siteId: ID!, $input:AddStaticHostInput!) {
    site(accountId: $accountId) {
      addStaticHost(
        siteId: $siteId, 
        input: $input
      ) {
      hostId
    }
  }
}

Variáveis GraphQL

{
    "accountId": "26",
    "siteId": 126,
    "input": {
        "primaryManagementIp": "192.168.4.2",
        "secondaryManagementIp": "192.168.4.3",
        "vrid": 100
    }
}

Recursos Relacionados