Объект SETTINGS

AUTH_CERTS

Объект

Информация о сертификатах пользователей, приложений, веб-сервера и Kaspersky Security Center.

Да

-

certificate_admin

Строка

Сертификат администратора.

Base64 представление сертификата.

certificate_admin_name

Строка

Имя сертификата администратора.

Имя файла, содержащего сертификат.

certificate_app_ca

Строка

Корневой сертификат приложений.

Base64 представление сертификата.

certificate_app_ca_name

Строка

Имя корневого сертификата приложений.

Имя файла, содержащего сертификат.

certificate_app_cl

Строка

Клиентский сертификат приложений

Base64 представление сертификата.

certificate_app_cl_key

Строка

Ключ клиентского сертификата приложений.

Base64 представление ключа.

certificate_app_cl_key_name

Строка

Имя ключа клиентского сертификата приложений.

Имя файла, содержащего ключ.

certificate_app_cl_name

Строка

Имя клиентского сертификата приложений.

Имя файла, содержащего сертификат.

certificate_ksc_server

Строка

Сертификат Kaspersky Security Center.

Base64 представление сертификата.

certificate_ksc_server_name

Строка

Имя сертификата Kaspersky Security Center.

Имя файла, содержащего сертификат.

certificate_web_tls

Строка

Сертификат веб-сервера.

Base64 представление сертификата.

certificate_web_tls_key

Строка

Ключ сертификата веб-сервера.

Base64 представление ключа.

certificate_web_tls_key_name

Строка

Имя ключа сертификата веб-сервера.

Имя файла, содержащего ключ.

certificate_web_tls_name

Строка

Имя сертификата веб сервера.

Имя файла, содержащего сертификат.

DEVICE

Объект

Имя устройства.

Да

-

device_name

Строка

Имя устройства для отображения в Kaspersky Security Center.

KSC

Объект

Объект, содержащий информацию о взаимодействии с Kaspersky Security Center.

Да

-

command

Строка

Команда, подготовленная для отправки на Kaspersky IoT Secure Gateway 1000.

Нет

reboot

heartbeat

Целое число

Период синхронизации с Kaspersky Security Center в секундах.

Целое число.

MODEM

Объект

Информация о модеме и параметры для операторов связи.

Да

-

connection_quality

Целое число

Показатель текущего качества связи.

Нет

Получается автоматически.

connection_status

Строка

Статус связи.

Нет

on – модем подключен и передает данные, off – модем присутствует в системе, но соединение неактивно, na – модем отсутствует в системе, unknown – статус неизвестен.

is_enable

Литерал

Включение и отключение модема.

Да

true – модем включен, false – модем выключен.

primary_dns

Строка

Основной DNS-сервер.

Нет

Строка в формате XXX.XXX.XXX.XXX, например: "primary_dns": "8.8.8.8".

profileList

Список объектов

Список профилей операторов сотовой связи.

Да

-

fileContent

Строка

Содержимое файла профиля.

Да

Получается автоматически из файла профиля.

locked

Строка

Указывает, заблокирован профиль для изменений или нет.

Нет

Определяется на основе полей predefined и status.

modified

Строка

Дата и время последнего изменения профиля.

Да

Строка с датой и временем.

name

Строка

Имя профиля.

Произвольное имя профиля.

predefined

Литерал

Флаг, определяющий, является профиль предустановленным или нет.

true – профиль предустановлен, false – профиль добавлен пользователем.

status

Строка

Текущий статус профиля.

active – профиль активен, inactive – профиль не активен.

uuid

Строка

Уникальный идентификатор профиля.

Нет

Строковое представление boost::uuids::uuid.

secondary_dns

Строка

Дополнительный DNS-сервер.

Нет

Строка в формате XXX.XXX.XXX.XXX, например: "secondary_dns": "8.8.4.4".

MQTT_NOTIFICATION

Объект

Параметры MQTT-уведомлений.

Да

-

auth_enabled

Литерал

Включение и отключение отправки MQTT-уведомлений от имени определенного пользователя.

Да

true – отправка от имени пользователя включена, false – отправка от имени пользователя выключена.

certificate_cert

Строка

Клиентский сертификат, соответствующий корневому сертификату.

Да, если "certs_enable": true

Base64 представление сертификата.

certificate_key

Строка

Клиентский ключ, соответствующий клиентскому сертификату.

Да, если "certs_enable": true

Base64 представление ключа.

certificate_root

Строка

Корневой сертификат удостоверяющего центра.

Да, если "certs_enable": true

Base64 представление сертификата.

certs_enabled

Литерал

Включение и отключение использования защищенного TLS-соединения для отправки MQTT-уведомлений.

Да

true – защищенное соединение включено, false – защищенное соединение выключено.

event_topic

Строка

Имя MQTT-топика для отправки MQTT-уведомлений.

Да

Имя MQTT-топика.

login

Строка

Имя пользователя.

Да, если

Имя пользователя.

notifications_enabled

Литерал

Включение и отключение отправки событий по протоколу MQTT.

Да

true – отправка по протоколу MQTT включена, false – отправка по протоколу MQTT выключена.

password

Строка

Пароль пользователя.

Да, если "auth_enabled": true

Пароль, соответствующий имени пользователя.

server_address

Строка

IP-адрес MQTT-брокера.

Да

Строка в формате XXX.XXX.XXX.XXX, например: "server_address": "192.168.1.123".

server_port

Целое число

Порт MQTT-брокера.

Да

Для соединения Kaspersky IoT Secure Gateway 1000 c MQTT-брокером, который находится во внутренней сети вы можете использовать порты 1883 и 8883, во внешней сети – 8883.

SYSLOG

Объект

Параметры отправки журнала syslog.

Да

-

certificate

Строка

Содержимое сертификата безопасности для передачи событий по протоколу TCP/TLS.

Base64 представление сертификата.

enable

Литерал

Включение и отключение сервера syslog для отправки событий.

true – использование сервер syslog для отправки событий включено, false – использование сервер syslog для отправки событий выключено.

host

Строка

IP-адрес сервера syslog.

Строка в формате XXX.XXX.XXX.XXX, например: "host": "192.168.1.122".

mode

Строка

Протокол передачи событий.

"tcp" – отправка событий по протоколу TCP, "udp" – отправка событий по протоколу UDP, "???" – отправка событий по протоколу TCP с использованием TLS-соединения.

port

Целое число

Порт сервера syslog.

Порт сервера.

TIME

Объект

Текущие дата и время. Доступно только для чтения.

Да

-

date

Строка

Текущая дата.

Нет

Дата в формате "YYYY/MM/DD", например: "date": "2023/12/31".

time

Строка

Текущее время.

Нет

Время в формате "HH:MM:SS", например: "time": "23:59:59".

UPDATE

Объект

Информация об обновлениях.

Да

-

firmware_update_start

Литерал

Запуск процедуры обновления Kaspersky IoT Secure Gateway 1000.

true – будет запущена процедура обновления, false – значение по умолчанию.