#424: Как подключиться к UserGate с помощью API

Отредактирована: 155 дней назад

Симптомы

  • Как подключиться по API к UserGate и вызвать метод?
  • Как использовать API?
  • Шаблоны использования API.

Решение

Про API поверх HTTPS подробно рассказано в этой опубликованной статье.

Перед использованием API нужно:

  1. Проверить права доступа на API у учетной записи администратора веб-консоли. Изначально доступ к API есть только у корневого администратора (по умолчанию Admin).
  2. Разрешить сервис XML-RPC для управления. Подробнее в этой статье.

Далее можно использовать базовые шаблоны для написания скриптов приведены ниже.

Для NGFW:

import xmlrpc.client as rpc
from pprint import pprint

SERVER = "IP_адрес"
PORT = 4040
USER = "логин"
PASSWORD = "пароль"

server = rpc.ServerProxy(f'http://{SERVER}:{PORT}/rpc', verbose=False)
res = server.v2.core.login(USER, PASSWORD, {})
auth_token = res['auth_token']

# тут любой код на Python


server.v2.core.logout(auth_token)

Для MC, LogAn и SIEM:

import xmlrpc.client as rpc
from pprint import pprint

SERVER = "IP_адрес"
PORT = 4041
USER = "логин"
PASSWORD = "пароль"

server = rpc.ServerProxy(f'http://{SERVER}:{PORT}/rpc', verbose=False)
res = server.v1.core.login(USER, PASSWORD, {})
auth_token = res['auth_token']

# тут любой код на Python


server.v1.core.logout(auth_token)