Объект restconf

Доступные команды объекта restconf приведены в таблице.

Доступные команды объекта restconf

КомандаОписание

set restconf

Создание конфигурации RESTCONF со значениями по умолчанию

set restconf auth-type <тип>

Назначение типа аутентификации, где <тип> может принимать значения:

  • client-certificate – тип аутентификации с использованием клиентского сертификата для идентификации пользователя;
  • user – тип аутентификации с использованием имени пользователя и пароля для доступа к API.

Значение по умолчанию: user

set restconf debug <значение>

Управление отладкой и мониторингом работы RESTCONF, где <debug> – уровень детализации отладочных сообщений, может принимать значения:

  • 0 – отключение отладки (по умолчанию);
  • 1 – базовая информация о работе системы и основных событиях;
  • 2 – более подробная информация, включая некоторые внутренние события и предупреждения;
  • 3 – полная отладочная информация, включая детализированные логи о внутреннем состоянии, вызовах функций и т.п.

Значение по умолчанию: 0

set restconf enable <false/true>

Управление режимом RESTCONF.

Значение по умолчанию: false

set restconf enable-core-dump <false/true>

Управление режимом создания снимка (дампа) состояния памяти ядра.

Значение по умолчанию: false

set restconf log-destination <тип>

Указание формата записи журнала, где <тип> может принимать значения:

  • syslog – запись в службу syslog;
  • file – запись в файл.

Значение по умолчанию: syslog

set restconf pretty <false/true>

Управление режимом форматирования заголовков в формате XML или JSON

Значение по умолчанию: true

set restconf server-ca-cert-path <путь>

Указание файла сертификата корневого удостоверяющего центра (CA)

set restconf server-cert-path <путь>

Указание файла сертификата сервера

set restconf server-key-path <путь>

Указание закрытого ключа, который соответствует сертификату сервера

set restconf socket <идентификатор> <IP-адрес> <порт> 

Настройка соединения к API в программном пространстве:

  • <идентификатор> – уникальный идентификатор, который определяет область применения API;

  • <IP_адрес> – IP-адрес сервера, на котором располагается API;

  • <порт> – номер порта, через который осуществляется доступ к API на указанном сервере.

Пример команды:

set restconf socket default 127.0.0.1 8080
BASH

set restconf timeout <значение>

Длительность (в секундах) сессии пользователя.

Значение по умолчанию: 0 (длительность не ограничена)