Gerenciamento de configuração baseado em API REST

Uma API REST é uma interface de programação de aplicações (API ou API web) que atende às restrições do estilo arquitetônico REST e permite a interação com serviços web RESTful. No que diz respeito às configurações, a maioria dos fornecedores de dispositivos oferece suporte à API REST em diferentes níveis para leitura e gravação da configuração do dispositivo, em partes ou como um todo, durante o processo de backup.

O Network Configuration Manager utiliza as APIs REST para que os usuários tenham uma experiência de interface simplificada. e possam se concentrar em uma parte específica da configuração sem se preocupar com a sintaxe dos comandos e a hierarquia de configuração. Além disso, a interface gráfica do usuário (GUI) da API REST foi projetada para se assemelhar à interface gráfica do usuário (GUI) do dispositivo, para uma melhor compreensão dos usuários.

Suporte ao gerenciamento de configuração baseado em API REST

O suporte ao gerenciamento de configuração baseado na API REST foi fornecido aos firewalls Fortigate e Palo Alto. Estamos trabalhando para fornecer suporte para mais dispositivos. Os dispositivos Juniper e Arista são os próximos na fila, seguidos pelo Cisco FTD. Entre em contato com o suporte do Network Configuration Manager (ncm-support@manageengine.com) caso deseje suporte para um fornecedor específico.

O gerenciamento de configuração baseado em API REST funciona com Configlets REST.

Benefícios do gerenciamento de configuração baseado em API REST

As APIs REST são mais rápidas ao fazer backup de configurações completas.
Os usuários não precisam memorizar sintaxes de comando para atualizar uma parte específica da configuração.
Os usuários não precisam se preocupar com a hierarquia de objetos na configuração.
Os objetos importantes da configuração podem ser visualizados em formato de grade no Network Configuration Manager.
As APIs REST fornecem uma interface gráfica semelhante à interface gráfica do dispositivo (por exemplo, a interface gráfica do firewall), o que facilita a atualização de parte da configuração diretamente do Network Configuration Manager.

Credenciais REST

Para usar os recursos da API REST, o Network Configuration Manager precisa de credenciais REST para se conectar ao dispositivo antes de executar as APIs REST. Essas credenciais podem ser fornecidas diretamente no slide "Aplicar Credenciais".

Cada fornecedor precisa definir parâmetros diferentes durante a conexão com as APIs REST, juntamente com os parâmetros de autenticação.
O Network Configuration Manager fornece os campos para cada um desses parâmetros com seus valores padrão baseados no fornecedor, no mesmo slide de credenciais.
É possível optar por gerenciar o dispositivo apenas com as Credenciais REST ou com uma combinação de credenciais CLI e REST.
Para funções importantes, como habilitar/desabilitar a detecção de mudanças no syslog, é recomendável gerenciar o dispositivo usando uma combinação de credenciais CLI e REST.

Consulte as etapas a seguir para saber mais sobre como associar credenciais REST a um dispositivo específico.

Acessar inventário > Dispositivos.
Selecione os dispositivos nos quais deseja aplicar as Credenciais REST.
Selecione "Aplicar Credenciais" nas opções.
Selecione "API REST" como protocolo caso queira gerenciar os dispositivos apenas com credenciais REST. Caso contrário, selecione o protocolo desejado, forneça as credenciais CLI adequadas e, em seguida, selecione a aba API REST para fornecer as credenciais REST.
Marque "Usar API REST para comunicação sempre que aplicável". (Esta opção estará disponível apenas ao usar credenciais REST junto com o protocolo CLI.)
Forneça todos os parâmetros necessários no formulário e salve as credenciais.

Configlets REST

Configlets Rest são objetos de configuração, como endereço, política, regras de segurança, etc. É possível acessar Configlets REST em Automação de configuração > Configlets > Configlets REST.

Cada configlet tem um conjunto diferente de operações, como adicionar, editar, visualizar, excluir, renomear, visualizar tudo, clonar, executar, etc.

Operação	Descrição
ADD	Adiciona um novo objeto à configuração do dispositivo.
Editar	Fornece uma lista de objetos disponíveis no dispositivo, assim, os usuários podem então selecionar um objeto específico. Os detalhes sobre o objeto selecionado serão obtidos do dispositivo e exibidos aos usuários, que podem atualizar qualquer detalhe/parâmetro específico para aquele objeto e executar o configlet para salvar as mudanças no dispositivo.
Visualizar	Fornece uma lista de objetos disponíveis no dispositivo, assim, os usuários podem então selecionar um objeto específico. Os detalhes sobre o objeto selecionado serão obtidos do dispositivo e exibidos aos usuários em modo somente leitura.
Visualizar tudo	Exibe todos os objetos disponíveis no dispositivo em uma grade, juntamente com seus detalhes.
Excluir	Fornece uma lista de objetos disponíveis no dispositivo, assim, os usuários podem selecionar um objeto específico e executar o configlet para excluí-lo.
Renomear	Os usuários podem selecionar um objeto específico e fornecer um novo nome para renomeá-lo no dispositivo.
Clonar	Os usuários podem selecionar um objeto específico e fornecer um novo nome para renomeá-lo no dispositivo, com o nome fornecido e suas propriedades.
Executar	A maioria dos dispositivos sem firewall possui objetos que só podem ser visualizados e executados como comandos CLI. Para esses dispositivos e objetos de configuração, haverá apenas uma operação disponível: "Executar". O comando será executado no dispositivo com os parâmetros fornecidos.