COREmanager API
Порядок работы с API-функциями см. в статье Взаимодействие через API .
Доступ к функциям
Функция: userrights.group
Результат: список элементов
Доступ к функциям
Уровень доступа: admin+
- name — Имя
- level — Уровень доступа
- users — Количество пользователей
- desc — Описание
Удалить выбранные группы
Функция: userrights.group.delete
Удалить выбранные группы
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции userrights.group.
Результат: успешное выполнение операции или сообщение об ошибке
Права пользователей
Функция: userrights
Результат: список элементов
Права
Уровень доступа: admin+
- caption — Наименование
- access — Доступ
Ограничить доступ к элементам списка
Функция: userrights.filter
Ограничить доступ к элементам списка
Уровень доступа: admin+
Вернуть настройки по умолчанию. Удаляет все настройки доступа, которые были сделаны для данного пользователя/группы, включая права на колонки и столбцы, если это список или форма
Функция: userrights.delete
Вернуть настройки по умолчанию. Удаляет все настройки доступа, которые были сделаны для данного пользователя/группы, включая права на колонки и столбцы, если это список или форма
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.
Результат: успешное выполнение операции или сообщение об ошибке
Наименование
Функция: userrights.fields
Результат: список элементов
Список полей (столбцов)
Уровень доступа: admin+
- caption — Наименование
- access — Доступ
Включить
Функция: userrights.fields.resume
Включить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.fields.
Результат: успешное выполнение операции или сообщение об ошибке
Вернуть настройки по умолчанию. Удаляет все настройки доступа, которые были сделаны для данного пользователя/группы, включая права на колонки и столбцы, если это список или форма
Функция: userrights.fields.delete
Вернуть настройки по умолчанию. Удаляет все настройки доступа, которые были сделаны для данного пользователя/группы, включая права на колонки и столбцы, если это список или форма
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.fields.
Результат: успешное выполнение операции или сообщение об ошибке
Выключить
Функция: userrights.fields.suspend
Выключить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.fields.
Результат: успешное выполнение операции или сообщение об ошибке
Права на поле
Функция: userrights.fields.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент name из функции userrights).
- elid — уникальный идентификатор (элемент name из функции userrights.fields)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент name из функции userrights).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент name из функции userrights).
- elid — уникальный идентификатор (элемент name из функции userrights.fields)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- inhereted — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Не задавать явно права на поле. Права будут взяты из прав групп, в которые входит пользователь
- read — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить чтение поля
- write — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить редактирование поля
- new — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешить редактирование поля во время создания объекта
Доступ к функции
Функция: userrights.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент key из функции userrights.group).
- elid — уникальный идентификатор (элемент name из функции userrights)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент key из функции userrights.group).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент key из функции userrights.group).
- elid — уникальный идентификатор (элемент name из функции userrights)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- inhereted — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Не задавать права явно. В этом случае права определяются согласно другим правилам
- access — Доступ. Разрешить/запретить доступ к функции
- inherit — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Распространяет права на все функции группы
Политики
Функция: userrights.policy
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент key из функции userrights.group).
- elid — уникальный идентификатор (элемент name из функции userrights)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент key из функции userrights.group).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент key из функции userrights.group).
- elid — уникальный идентификатор (элемент name из функции userrights)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- policy — Политика по умолчанию. Укажите, какой доступ будет у пользователя к функциям, для которых ограничения не заданы явно. При изменении значения сбрасывает существующие настройки доступа. Если пользователь входит в какую-либо группу, групповые настройки доступа сохраняются
Включить
Функция: userrights.resume
Включить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.
Результат: успешное выполнение операции или сообщение об ошибке
Выключить
Функция: userrights.suspend
Выключить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.
Результат: успешное выполнение операции или сообщение об ошибке
Группа
Функция: userrights.group.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент key из функции userrights.group)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент key из функции userrights.group)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- level — Уровень доступа. Выберите уровень доступа пользователей, для которых будут применимы правила новой группы. Уровень определяет список модулей, отображаемых в интерфейсе при назначении прав группы, и не может быть изменен
- name — Имя. Вы можете изменить имя группы, никаких изменений в правах пользователей это не повлечет
- default — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Права, установленные для этой группы, будут автоматически применяться для всех пользователей с подходящим уровнем доступа
- user — Пользователь. Выберите пользователя, который будет использоваться для получения данных, специфичных для выбранного уровня доступа, то есть список модулей для редактирования прав будет составляться на основе модулей, доступных этому пользователю.
Набор полей в формах и списках может различаться у различных пользователей с одинаковых уровнем доступа. Поэтому, выбор правильного пользователя, в некоторых случаях, может быть принципиален
- _desc — .
- policy — По умолчанию. По умолчанию
Наименование
Функция: userrights.group.users
Результат: список элементов
Пользователи группы
Уровень доступа: admin+
- name — Наименование
- status — Состояние
Включить
Функция: userrights.group.users.resume
Включить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.group.users.
Результат: успешное выполнение операции или сообщение об ошибке
Выключить
Функция: userrights.group.users.suspend
Выключить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции userrights.group.users.
Результат: успешное выполнение операции или сообщение об ошибке
Пулы IP-адресов
Функция: ipmgr2
Результат: список элементов
Пулы IP адресов
Уровень доступа: admin+
- name — Имя пула
- note — Примечания
- usage — Использование адресов
Пул адресов:
Функция: ipmgr2.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции ipmgr2)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции ipmgr2)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name — Имя пула. Имя пула позволяет приложению выбирать, из какого набора адресов необходимо выделить адрес
- note — Примечания. Произвольное описание пула адресов
Установка фильтра.
ipmgr2.filter
Удалить
Функция: ipmgr2.delete
Удалить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции ipmgr2.
Результат: успешное выполнение операции или сообщение об ошибке
Блок адресов
Функция: ipmgr2.ranges
Результат: список элементов
Блоки адресов
Уровень доступа: admin+
- id — Id
- name — Блок адресов
- usage — Использование адресов
Удалить блок. Адреса, выделенные для данного пула в рамках этого блока, изменены не будут
Функция: ipmgr2.ranges.delete
Удалить блок. Адреса, выделенные для данного пула в рамках этого блока, изменены не будут
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции ipmgr2.ranges.
Результат: успешное выполнение операции или сообщение об ошибке
Адрес
Функция: ipmgr2.ranges.ip
Результат: список элементов
Занятые IP адреса
Уровень доступа: admin+
- name — Адрес
- size — Количество адресов
- domain — Доменное имя
- status — Состояние
- pool — Пул адресов
- note -
Освободить
Функция: ipmgr2.net.ip.delete
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции ipmgr2.ranges.ip.
Результат: успешное выполнение операции или сообщение об ошибке
Установка фильтра.
ipmgr2.ranges.ip.filter
Просмотреть историю изменений
Функция: ipmgr2.net.ip.history
Просмотреть историю изменений
Уровень доступа: admin+
Редактирование IP адреса
Функция: ipmgr2.net.ip.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции ipmgr2.ranges).
- elid — уникальный идентификатор (элемент name из функции ipmgr2.ranges.ip)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции ipmgr2.ranges).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции ipmgr2.ranges).
- elid — уникальный идентификатор (элемент name из функции ipmgr2.ranges.ip)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name — Адрес. IP адрес
- domain — Доменное имя. Обратное доменное имя (PTR)
- locked — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Адреса, помеченные как защищенные, нельзя удалить и использовать вновь. Это дополнительная защита от ошибочных действий администраторов или роботов, призванная ни при каких обстоятельствах не нарушить работу вашей сети
- note — Примечание. Можно указать любую полезную вам информацию
Установка фильтра.
ipmgr2.net.ip.filter
Редактирование блока адресов
Функция: ipmgr2.ranges.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент name из функции ipmgr2).
- elid — уникальный идентификатор (элемент id из функции ipmgr2.ranges)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент name из функции ipmgr2).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент name из функции ipmgr2).
- elid — уникальный идентификатор (элемент id из функции ipmgr2.ranges)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name — Блок адресов. Укажите блок IP-адресов, который может быть использован для данного пула. Можно указывать отдельные адреса (123.45.67.89), адреса по маске (123.45.67.0/24), либо диапазон адресов (123.45.67.89-123.45.67.98). Вы можете указать любой диапазон (например 0.0.0.0/0 — все IPv4 адреса), но доступными будут только те, для которых есть соответствующая запись в списке физических сетей. Для IPv6 можно указывать только адреса по маске (fe80::/64), размер префикса маски не может быть больше /64
- createnet — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы автоматически создать запись в списке физических сетей
- gateway — Адрес шлюза. Адрес шлюза, используется другими продуктами для настройки сети
Установка фильтра.
ipmgr2.ranges.filter
Фоновые задания
Функция: longtask
Результат: список элементов
Фоновые задания
Уровень доступа: admin+
- manager — Панель
- queue — Имя очереди
- realname — Имя скрипта
- id — Идентификатор
- created — Время создания
- startdate — Время запуска
- enddate — Время завершения
- pidfile — PID-файл
- state — Статус
Установка фильтра.
longtask.filter
Завершить задание. Если задание уже запущено, то его выполнение будет прервано.
Функция: longtask.delete
Завершить задание. Если задание уже запущено, то его выполнение будет прервано.
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент pidfile из функции longtask.
Результат: успешное выполнение операции или сообщение об ошибке
Фоновое задание
Функция: longtask.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент pidfile из функции longtask)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент pidfile из функции longtask)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- manager — Панель. Краткое имя панели управления, запустившей задание
- queue — Имя очереди. Имя очереди, в которую было помещено задание
- realname — Имя скрипта. Имя скрипта или исполняемого файла
- id — Идентификатор. Идентификатор задания, как правило, содержит основные параметры задания
- created — Время создания. Время помещения задания в очередь
- startdate — Время запуска. Время запуска задания
- enddate — Время завершения. Время завершения задания
- pidfile — PID-файл. Путь до PID-файла
- depends — Зависимости. Задания, от которых зависит текущее задание
- params — Доп. информация. Список параметров задания
- result — Результат. Содержимое стандартного потока вывода и ошибок
Черные списки DNSBL
Функция: ipmgr2.dnsbl
Результат: список элементов
Черные списки
Уровень доступа: admin+
- name — Адрес черного списка
Переименовать
Функция: ipmgr2.dnsbl.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции ipmgr2.dnsbl)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции ipmgr2.dnsbl)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name — Адрес черного списка. Доменное имя черного списка по которому осуществляется проверка блокировки IP-адресов
Отключить черный список
Функция: ipmgr2.dnsbl.delete
Отключить черный список
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции ipmgr2.dnsbl.
Результат: успешное выполнение операции или сообщение об ошибке
Журнал
Функция: gdpr_journal
Результат: список элементов
Журнал
Уровень доступа: admin+
- action_object — Объект действия
- doc_name — Наименование документа
- username — Пользователь
- action_type — Действие
- ip — IP-адрес
- action_date — Дата действия
Установка фильтра.
gdpr_journal.filter
Менеджер файлов
Функция: file
Результат: список элементов
Менеджер файлов
Уровень доступа: user super
- dname — Имя
- size — Размер
- attr — Права
- user — Владелец
- group — Группа
- time — Дата изменения
Скачать файл
Функция: file.download
Скачать файл
Уровень доступа: user super
Проверить выделенные файлы на вирусы
Функция: file.avcheckparams
Проверить выделенные файлы на вирусы
Уровень доступа: user super
Восстановление
Функция: file.upload
Уровень доступа: user super
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции file)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции file)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- type — Тип файла. Укажите, откуда вы хотите закачать файл: с локального компьютера или с использованием ссылки на файл, расположенный на другом сервере
- url — URL. Укажите ссылку на файл, который вы хотите закачать в текущий каталог, например, http://example.com/dir/file.html
- name — Имя файла. Укажите, с каким именем файл должен быть сохранён в текущем каталоге. Если вы оставите это поле пустым, имя файла будет выделено из URL
Удалить файлы
Функция: file.delete
Удалить файлы
Уровень доступа: user super
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции file.
Результат: успешное выполнение операции или сообщение об ошибке
Восстановление
Функция: file.search
Уровень доступа: user super
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции file)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции file)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- search_type — Режим. Выполнить новый поиск или посмотреть результаты предыдущего. Результаты предыдущего поиска доступны, если поиск ранее выполнялся и временный файл с результатами поиска еще доступен
- mask_filename — Маска имени. Введите последовательность символов для поиска файлов. Допускается использовать символы '*' и '?'
- opt_subdir — Искать в подкаталогах. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включите, если требуется искать во всех подкаталогах указанного каталога
- opt_filecontent — Искать по содержимому. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включите, если требуется выполнить поиск по содержимому файла. Предупреждение: такой поиск является ресурсоемкой операцией
- mask_filecontent — Маска содержимого. Введите часть строки или регулярное выражение для поиска по содержимому файла. Например, регулярное выражение может начинаться с символа '^' (для обозначения начала строки) и заканчиваться символом '$' (для обозначения конца строки)
- encoding — В кодировке. Введенная маска содержимого будет перекодирована в указанную кодировку
- dir_prev — Каталог. Каталог, в котором выполнялся поиск
- mask_filename_prev — Маска имени. Маска имени файла, по которой выполнялся поиск
- opt_subdir_prev — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Выполнялся ли поиск в подкаталогах
- opt_filecontent_prev — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Выполнялся ли поиск по содержимому файла
- mask_filecontent_prev — Маска содержимого. Маска, по которой выполнялся поиск в содержимом файла
- encoding_prev — В кодировке. Поиск по содержимому выполнялся в указанной кодировке
Атрибуты
Функция: file.unixattr
Уровень доступа: user super
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции file)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции file)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- dname — Имя. Имя файла или каталога
- dest — Ссылается на. Значение символической ссылки
- uid — Владелец. Имя пользователя, которому принадлежат файл или каталог
- gid — Группа. Группа пользователей, которой принадлежат файл или каталог
- recursive — Изменить дочерние элементы. Укажите, каким образом применить изменения для дочерних элементов выбранного каталога (каталогов)
- mode — Права доступа. Вы можете указать права доступа к файлу в виде маски в восьмеричной системе счисления
- pur — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Укажите права на чтение, запись и исполнение для владельца. Право на исполнение для каталога означает право просмотра его содержимого
- puw — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
- pux — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
- pgr — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Укажите права на чтение, запись и исполнение для группы. Право на исполнение для каталога означает право просмотра его содержимого
- pgw — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
- pgx — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
- por — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Укажите права на чтение, запись и исполнение для всех, кто не является владельцем и не принадлежит группе. Право на исполнение для каталога означает право просмотра его содержимого
- pow — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
- pox — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".)
Ограничение доступа к каталогам WWW-домена
Функция: file.diraccess
Ограничение доступа к каталогам WWW-домена
Уровень доступа: user super
Копировать
Функция: file.copyto
Уровень доступа: user super
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции file)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции file)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- move — Перенести файлы. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Перенести выбранные элементы в указанный каталог
- overwrite — Перезаписать. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Перезаписывать файлы, каталоги и содержимое каталогов
- goto — Перейти в выбранный каталог. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Сделать выбранный каталог текущим после завершения операции
Восстановление
Функция: file.settings
Уровень доступа: user super
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции file)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции file)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- editor_codepage — Кодовая страница редактора файлов. Укажите, в какой кодовой странице будут открываться файлы в редакторе
- editor_rows — Строк в редакторе файлов. Укажите приблизительную высоту окна редактора файлов в строках. Допустимы значения от 5 до 100. Фактическое количество строк в окне редактора зависит от размера выбранного шрифта
- default_arc — Архиватор по умолчанию. Укажите, какой архиватор следует использовать при скачивании каталога или группы файлов
Создать файл или каталог
Функция: file.new
Уровень доступа: user super
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции file)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции file)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- filetype — Тип. Укажите, что именно вы хотите создать — файл, каталог или ссылку
- name — Имя. Имя файла, каталога или ссылки
- dest — Значение. Имя файла или каталога, на который будет создана эта ссылка
Перейти в каталог
Функция: file.folder
Уровень доступа: user super
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции file)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции file)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
Редактировать файл
Функция: file.edit
Уровень доступа: user super
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции file)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции file)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- full_filepath — Имя файла. Полный путь к файлу. Для пользователей указывается путь относительно домашнего каталога
- encoding — Кодировка. Выберите кодировку файла. Предупреждение — смена кодировки приведет к перезагрузке содержимого файла и потере изменений, внесенных в редакторе
- rowcount — Отображать последниx строк. Укажите, какое количество строк файла необходимо отобразить
- fdata — .
- savetime — Сохранено в . В этом поле отображается время сохранения файла. Указывается время сервера
Архивировать
Функция: file.pack
Уровень доступа: user super
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции file)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции file)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- filetype — Тип. Выберите тип архива
- arcname — Имя архива. Введите имя для нового архива (без расширения)
- remove_files — Удалить файлы. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, если требуется удалить выделенные файлы (каталоги) после помещения их в архив
Распаковать архив(ы)
Функция: file.extract
Уровень доступа: user super
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции file)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции file)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- newdir — Создать каталог. В этом поле можно указать произвольный подкаталог для распаковки архива относительно выбранного в дереве. Если указанный подкаталог не существует, он будет создан
- goto — Перейти в выбранный каталог. (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Сделать выбранный каталог текущим после завершения операции
Условия использования
Функция: gdpr_docs
Результат: список элементов
Условия использования
Уровень доступа: admin+
- id — Id
- name — Наименование документа
- locale — Локализация
- entry_date — Дата вступления в силу
- change_date — Дата изменений
- status — Статус
Просмотреть историю изменений
Функция: gdpr_docs.history
Просмотреть историю изменений
Уровень доступа: admin+
Условия использования
Функция: gdpr_docs.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции gdpr_docs)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции gdpr_docs)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- type — Тип условия. Тип создаваемого условия
- name — Название документа. Наименование создаваемого документа
- url — Ссылка на документ. Ссылка на ресурс, где размещен документ
- desc_condition — Описание условия. Описание условия принятия документа
- entry_date — Дата вступления в силу. Дата вступления документа в силу
- locale — Локализация. Локализация документа
- need_agree — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Необходимо принятие документа
- show_after_auth — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отображать данный документ сразу после авторизации
- show_in_warnings — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отображать ссылки в предупреждениях
Включить
Функция: gdpr_docs.resume
Включить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gdpr_docs.
Результат: успешное выполнение операции или сообщение об ошибке
Выключить
Функция: gdpr_docs.suspend
Выключить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gdpr_docs.
Результат: успешное выполнение операции или сообщение об ошибке
Установка фильтра.
gdpr_docs.filter
Фоновые задания сценария
Функция: test.longtask
Результат: список элементов
Фоновые задания теста
Уровень доступа: registered
- id — Идентификатор
- name — Имя
- queue — Имя очереди
Ожидать
Функция: test.longtask.wait
Уровень доступа: registered
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции test.longtask.
Результат: успешное выполнение операции или сообщение об ошибке
База IP-адресов
Функция: ipdb
Результат: список элементов
База IP-адресов
Уровень доступа: admin+
- range — Диапазон IP-адресов
- iptype — Группа IP-адресов
- gateway — Адрес шлюза
- netmask — Маска сети
Установка фильтра.
ipdb.filter
Удалить диапазон
Функция: ipdb.delete
Удалить диапазон
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент range из функции ipdb.
Результат: успешное выполнение операции или сообщение об ошибке
Параметры диапазона
Функция: ipdb.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент range из функции ipdb)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент range из функции ipdb)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- range — Диапазон IP-адресов. Диапазон IP-адресов в формате адрес_сети/маска_сети, первый_адрес-последний_адрес или в виде отдельного адреса
- netmask — Маска сети. Маска сети, используется другими продуктами для настройки сети
- gateway — Адрес шлюза. Адрес шлюза, используется другими продуктами для настройки сети
- iptype — Группа IP-адресов. Тип IP-адресов, который использует данная панель
Наименование
Функция: ipdb.addr
Результат: список элементов
IP-адреса
Уровень доступа: admin+
- ip — IP адрес
- domain — Доменное имя
- xtype — Тип адреса
IP-адрес
Функция: ipdb.addr.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент range из функции ipdb).
- elid — уникальный идентификатор (элемент ip из функции ipdb.addr)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент range из функции ipdb).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент range из функции ipdb).
- elid — уникальный идентификатор (элемент ip из функции ipdb.addr)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- ip — IP адрес. IP-адрес, для которого вы хотите изменить свойства
- domain — Доменное имя. Доменное имя, которое соответствует данному IP-адресу
Удалить специальный адрес
Функция: ipdb.addr.delete
Удалить специальный адрес
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент ip из функции ipdb.addr.
Результат: успешное выполнение операции или сообщение об ошибке
Домен специальных адресов
Функция: ipdb.settings
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент range из функции ipdb)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент range из функции ipdb)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- specdomain — Доменное имя. Домен, который будет добавлен к имени специальных адресов (gateway, broadcast, subnet). Специальные адреса резервируются автоматически при создании диапазона
SSL ключи
Функция: sslkey
Результат: список элементов
SSL ключи
Уровень доступа: registered
- server — Адрес панели
- user — Пользователь
- cert — Сертификат
- start — Дата создания
- expire — Дата окончания
- props — Свойства
Вы можете скачать ключ. Данная операция может быть выполнена только один раз. После скачивания, файл ключа будет удален
Функция: sslkey.download
Вы можете скачать ключ. Данная операция может быть выполнена только один раз. После скачивания, файл ключа будет удален
Уровень доступа: registered
Новый SSL ключ
Функция: sslkey.edit
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент key из функции sslkey)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент key из функции sslkey)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- server — Адрес панели. Различные адреса панели могут использовать различные SSL сертификаты для авторизации. Новый ключ будет действителен только для сертификата, используемого на данном адресе
- self — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Вы можете создать ключ для текущего пользователя или для любого другого пользователя, владельцем которого является текущий
- username — Имя пользователя. Введите имя пользователя, для которого вы намереваетесь создать ключ. Вы должны быть владельцем этого пользователя
- type — Действие. Вы можете создать новый ключ, использовать уже существующий, использовать текущий ключ (в случае, если для текущего подключения вы использовали ключ, не зарегистрированный в панели) или получить подписанный сертификат, чтобы сформировать ключ вручную
- name — Имя ключа. Произвольное имя, которое будет отображаться при выборе сертификата
- period — Срок действия (дней). Новый ключ будет действителен в течении указанного количества дней начиная с текущего дня
- passwd — . Пароль, которым будет закрыт созданный SSL ключ
- confirm — Подтверждение.
- subject — Имя ключа. Укажите имя имеющегося у вас ключа. Внимание, ваш ключ должен быть подписан сертификатом, указанным в настройках HTTP сервера
- request — Запрос SSL сертификата. В этом случае вы получите подписанный сертификат, для того, чтобы сформировать ключ, вам необходимо запаковать его в формате PKCS#12. Например, это может быть сделано следующей командой: openssl pkcs12 -export -in my.crt -inkey my.key -certfile ca.crt -out my.p12 -passout pass:ваш пароль
Удалить
Функция: sslkey.delete
Удалить
Уровень доступа: registered
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции sslkey.
Результат: успешное выполнение операции или сообщение об ошибке
Настройки системы
Функция: srvparam
Уровень доступа: admin+
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- srvname — Имя сервера. Имя сервера (hostname) — это доменное имя сервера. Должно иметь значение вида domain.com, в противном случае некоторые приложения могут работать не корректно.
- timezone — Часовой пояс. Часовой пояс определяет, по какому времени работает ваш сервер
- region — Регион. Регион, в котором находится часовой пояс
- location — Местоположение. Географическое местоположение
- autoupdate — Обновлять ПО автоматически. COREmanager и панели на на его основе поставляются в виде пакетов ОС. Для того чтобы иметь последнюю версию, необходимо регулярно устанавливать обновления пакетов, которые вы используете. Вы можете выбрать уровень обновления: только ISPmanager или все пакеты системы
- ispaccess — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включая данную опцию, вы разрешаете административный доступ к серверу команде технической поддержки компании ISPmanager
- supportaccess — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Включая данную опцию, вы разрешаете административный доступ к серверу команде технической поддержки вашего хостинг провайдера
- def_theme — Тема оформления по умолчанию.
- pwstrength — Уровень сложности пароля. Для вашей безопасности мы не рекомендуем использовать слабые пароли. Данная настройка запрещает использование слабых паролей в панели. При попытке установить слабый пароль будет выдаваться сообщение об ошибке
- socnetwork — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Позволяет включить авторизацию через соц. сети.
- servertype — Тип почтового сервера. Тип почтового сервера через который будут отправляться почтовые уведомления
- smtpserver — Адрес SMTP-сервера. Укажите адрес SMTP-сервера, с которого будет происходит отправка оповещений
- smtpuser — Учетная запись . Укажите имя учетной записи (полный адрес электронной почты, например, example@mail.com)
- smtppassword — Пароль. Введите пароль
- smtpport — Порт SMTP-сервера. Укажите порт, на котором работает SMTP-сервер, по умолчанию — 25-й порт
- sendername — Имя отправителя. Имя отправителя которое по умолчанию будет добавляться в письма
- expirejournaldays — Хранить журнал, дней. Количество дней, которое необходимо хранить записи в журнале операций
- expirelogdays — Хранить логи, дней. Количество дней, которое необходимо хранить архивы логов системы
Проблемные IP-адреса
Функция: ipmgr2.badip
Результат: список элементов
Проблемные IP-адреса
Уровень доступа: admin+
- ip — IP-адрес
- problem — Описание проблемы
- deletetime — Время возникновения проблемы
Разблокировать IP-адреса
Функция: ipmgr2.badip.delete
Разблокировать IP-адреса
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент ip из функции ipmgr2.badip.
Результат: успешное выполнение операции или сообщение об ошибке
Изменить
Функция: net.addr.edit
Изменить
Уровень доступа: admin+
Выполнить команду
Функция: test.runcommand
Уровень доступа: registered
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- command — Команда. Команда для выполнения в консоли
- chose_macros — Макрос команды. Макрос, который будет выполнять замену значения в команде
- output — Результат. Результат выполнения команды
- mustbe — Содержит строки. Строки, которые должен содержать результат, указываются в той последовательности, в которой встречаются в выводе команды. Разделителем является символ переноса строки
- chose_macros_mustbe — Макрос в Содержит строки. Макрос, который будет выполнять замену значения при поиске в последовательности, которая встречается в выводе команды
- randorder — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Поиск строк в выводе команды в произвольном порядке
- notbe — Не содержит строки. Строки, которые не должен содержать результат. Разделителем является символ переноса строки
- chose_macros_notbe — Макрос в Не содержит строки. Макрос который будет выполнять замену значения при поиске в последовательности, которая не встречается в выводе команды
Сценарии тестирования
Функция: test
Результат: список элементов
Записанные сценарии
Уровень доступа: registered
- number — Номер
- created — Время создания
- name — Наименование
- desc — Описание
- author — Автор
- panelname — Имя панели
- branch — Бранч
- bug — Номер баги
- runtype — Тип запуска
- dependencies — Зависимости
- ready — Параметры
Установка фильтра.
test.filter
Настройки
Функция: test.settings
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции test)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции test)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- username — Имя пользователя. Имя пользователя
- password — Пароль. Пароль
- not_accept — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Позволяет только загружать в хранилище тесты
Запуск теста удаленной панели
Функция: test.dependency
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции test)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции test)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- url — URL панели. URL адрес удаленной панели
- username — Имя пользователя. Имя пользователя удаленной панели
- password — Пароль. Пароль
- useexisting — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Показать тесты на удаленной панели
- new_test_name — Имя. Имя нового теста на удаленной панели
- existing_test — Тест. Имеющийся тест на удаленной машине
Удалить
Функция: test.delete
Удалить
Уровень доступа: registered
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции test.
Результат: успешное выполнение операции или сообщение об ошибке
Управление языками теста
Функция: test.language
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции test)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции test)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- request_lang — Язык запросов. Язык на котором будут отправляться запросы
Отключить готовность теста к загрузке
Функция: test.suspend
Отключить готовность теста к загрузке
Уровень доступа: registered
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции test.
Результат: успешное выполнение операции или сообщение об ошибке
Наименование
Функция: test.request
Результат: список элементов
Список запросов теста
Уровень доступа: registered
- id — Порядковый номер
- action — Имя функции
- desc — Описание действия
Ожидание запроса
Функция: test.request.waiter
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции test).
- elid — уникальный идентификатор (элемент id из функции test.request)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции test).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции test).
- elid — уникальный идентификатор (элемент id из функции test.request)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- waittime — Время ожидания, сек. Время ожидания результата запроса. Применяется к командам и проверкам. Не рекомендуется устанавливать на модифицирующие команды
Макрос
Функция: test.request.macros
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции test).
- elid — уникальный идентификатор (элемент id из функции test.request)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции test).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции test).
- elid — уникальный идентификатор (элемент id из функции test.request)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- macros_list — Макрос. Выберите макрос для поля
- field — Поле. Поле, для которого будет заменено значение
- value — Значение. Значение по умолчанию для поля
- name — Имя макроса. Выбор макроса по имени или создание нового
- delmacros — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Удалить выбранный макрос
- composite — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Составной макрос позволяет задать значение со статической и изменяемой макросом частью
- composite_value — Значение макроса. Поле для указания значение составного макроса
Изменение шага
Функция: test.request.edit
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции test).
- elid — уникальный идентификатор (элемент id из функции test.request)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции test).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции test).
- elid — уникальный идентификатор (элемент id из функции test.request)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- checkvalue — Значение проверки. Значение, которое проверяется во время выполнения теста
- checktype — Тип проверки. Выберите тип проверки
- macro_in_string — Макрос строки. Макрос ключевого поля для поиска строки
- test_query — Запрос теста.
- composite_elid — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Составной идентификатор для поиска строки с проверяемым значением
- composite_elid_value — Значение идентификатора. Значение составного идентификатора
- macros_value — Макрос значения. Макрос, на который будет заменено значение проверки
Выполнить последовательность запросов до указанного шага (не включительно). Если ничего не выбрано, будут выполнены все запросы
Функция: test.request.runto
Выполнить последовательность запросов до указанного шага (не включительно). Если ничего не выбрано, будут выполнены все запросы
Уровень доступа: registered
Включить
Функция: test.request.resume
Включить
Уровень доступа: registered
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции test.request.
Результат: успешное выполнение операции или сообщение об ошибке
Выключить
Функция: test.request.suspend
Выключить
Уровень доступа: registered
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции test.request.
Результат: успешное выполнение операции или сообщение об ошибке
Удалить
Функция: test.request.delete
Удалить
Уровень доступа: registered
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции test.request.
Результат: успешное выполнение операции или сообщение об ошибке
Восстановление
Функция: test.edit
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции test)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции test)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name — Наименование. Короткое описания сценария. По завершению записи будет автоматически подставлено имя первой модифицирующей функции
- desc — Описание. Опишите основную идею сценария
- branch — Бранч. Имя бранча в котором выполняется тест
- bug — Номер баги. Номер баги из багзиллы
- needdelete — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Удалять созданные объекты после выполнения теста
- runparams — Тип запуска. Будет ли запускаться тест в проигрывателе
- runos — Операционная система. Запускать тест на выбранных операционных системах (Если ничего не выбрано, то на всех)
- ready — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Тест доступен для загрузки на сервер
- environment — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Тест создающий объекты запускается первым и после выполнения всех тестов удаляет объекты
- dependency_test — Зависимость. Тест от которого будет зависить текущий тест.
Запуск теста
Функция: test.runmacros
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции test)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции test)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- usedefault — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Использовать значения по умолчанию из теста
Синхронизировать файлы тестов с удаленным хранилищем
Функция: test.synchronize
Синхронизировать файлы тестов с удаленным хранилищем
Уровень доступа: registered
Глобальные переменные
Функция: test.globalvariables
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции test)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции test)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
Включить готовность теста к загрузке
Функция: test.resume
Включить готовность теста к загрузке
Уровень доступа: registered
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции test.
Результат: успешное выполнение операции или сообщение об ошибке
Адреса панели
Функция: ihttpd
Результат: список элементов
Адреса панели
Уровень доступа: admin+
- port — Адрес
- props — Параметры
Наименование
Функция: ihttpd.certs
Результат: список элементов
Сертификаты для адреса
Уровень доступа: admin+
- domain — Доменное имя
- ip — IP-адрес
- status — Статус
Удалить
Функция: ihttpd.certs.delete
Удалить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент cert из функции ihttpd.certs.
Результат: успешное выполнение операции или сообщение об ошибке
Сертификат для доменов
Функция: ihttpd.certs.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент port из функции ihttpd).
- elid — уникальный идентификатор (элемент cert из функции ihttpd.certs)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент port из функции ihttpd).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент port из функции ihttpd).
- elid — уникальный идентификатор (элемент cert из функции ihttpd.certs)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- type — Тип сертификата. Выберите способ создания сертификата
- domain — Доменное имя сертификата. Введите имена доменов, которые будут добавлены в сертификат. При получении сертификата Let's Encrypt, для успешного завершения операции вам будет необходимо доказать, что вы контролируете данный домен
- ip — IP-адрес. IP-адрес панели
- domain_ip — IP-адрес домена. IP-адрес, на который ведет указанный домен
- cert — SSL сертификат. Укажите SSL сертификат, который вы желаете использовать
- key — Ключ SSL сертификата. Укажите ключ для вашего сертификата
- bundle — Цепочка SSL-сертификатов. Укажите цепочку SSL-сертификатов, которая будет добавлена в файл сертификата
Адрес
Функция: ihttpd.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент port из функции ihttpd)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент port из функции ihttpd)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- ip — IP адрес. Выберите IP адрес для приема входящих соединений
- port — Порт. Укажите номер порта, который будет использован для приема входящих соединений. Если оставить это поле пустым, будет использовано значение по умолчанию
- sslonly — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Встроенный WEB сервер может принимать запросы как по HTTP, так и по HTTPS протоколам. В случае запрета HTTP запросы будут автоматически перенаправляться на HTTPS
- ip_confirm — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Согласившись, вы удалите все адреса, которые прослушивают указанный порт
Удалить
Функция: ihttpd.delete
Удалить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент port из функции ihttpd.
Результат: успешное выполнение операции или сообщение об ошибке
Восстановление
Функция: ipmgr2.settings
Уровень доступа: admin+
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- type — Тип источника.
- url — URL сервера. Адрес удаленной панели, на которой настроена локальная база IP адресов
- user — Пользователь. Имя пользователя для доступа к IPmanager
- secret — Пароль. Пароль для доступа к этой панели. Именно его вы должны указывать при подключении этой панели в качестве удаленной базы IP адресов
- password — Пароль. Пароль для доступа к удаленной панели
- pool — Пул адресов. Пул адресов, который будет использован по умолчанию
- uselocal — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Все адреса, уже привязанные к интерфейсам сервера, будут добавлены в базу как свободные
- usedns — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Вы можете задать адрес DNSmanager 5, на котором будут создаваться записи обратных доменных имен (PTR)
- dnsurl — URL сервера. Адрес DNSmanager 5, на котором будут создаваться обратные доменные имена (PTR)
- dnsuser — Пользователь. Имя пользователя для доступа к DNSmanager
- dnspass — Пароль. Пароль пользователя для доступа к DNSmanager
- domain — Доменное имя для служебных адресов. Доменное имя, которое будет присваиваться служебным адресам
Журнал операций
Функция: journal
Результат: список элементов
Журнал операций
Уровень доступа: registered
- time — Время
- user — Пользователь
- ip — Удалённый IP-адрес
- funcname — Функция
Установка фильтра.
journal.filter
Просмотр журнала
Функция: journal.edit
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции journal)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции journal)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- time — Время. Время выполнения операции с панелью управления
- user — Пользователь. Пользователь, выполнивший операцию с панелью управления
- ip — Удалённый IP-адрес. IP-адрес, с которого пользователь выполнил операцию с панелью управления
- funcname — Функция. Имя вызванной функции панели управления
- params — Параметры. Список параметров, переданных функции панели управления
Наименование
Функция: journal.stat
Результат: отчёт
Использование функций за период
Уровень доступа: admin+
Журнал посещений
Функция: authlog
Результат: список элементов
Журнал посещений
Уровень доступа: registered
- time — Время
- user — Пользователь
- ip — Удалённый IP-адрес
Установка фильтра.
authlog.filter
Уведомления
Функция: problems
Результат: список элементов
Уведомления
Уровень доступа: admin+
- id — Id
- dateinit — Дата появления
- owner — Пользователь
- type — Тип
- problem_id — Идентификатор
- description — Описание
- properties — Свойства
- dateautosolve — Последняя попытка
- autosolvecount — Попытки
- sameproblemcount — Количество
- period — Период (мин.)
Настройки модуля уведомлений
Функция: problems.settings
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции problems)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции problems)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- keep_old — Хранить старые уведомления (дней). Информация об уведомлениях, которые не повторялись в течение заданного промежутка времени, будет автоматически удаляться. По умолчанию, через 30 дней
- keep_solved — Хранить решенные проблемы (дней). Информация о проблемах, которые были решены заданное количество дней назад, будет автоматически удаляться. По умолчанию, через неделю
- show_userproblems — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если опция включена, в общем списке будут отображаться проблемы пользователей. По умолчанию отключено
- notification_enabled — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправлять Email-уведомления о проблемах
- smtpserver — SMTP-сервер. SMTP-сервер для отправки уведомлений
- smtpport — Порт SMTP-сервера. Порт SMTP-сервера для отправки уведомлений
- address_to — Email получателя уведомлений. Укажите email адрес получателя, на который будут высылаться сообщения о появлении новых уведомлений
- address_from — Email отправителя уведомлений. Укажите email, от имени которого будут отправляться сообщения
- plang — Язык описания уведомлений. Язык, на котором будет генерироваться текст описания уведомления
Произвести попытку решения проблемы
Функция: problems.solve
Произвести попытку решения проблемы
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции problems.
Результат: успешное выполнение операции или сообщение об ошибке
Параметры уведомления
Функция: problems.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции problems)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции problems)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- id — Id. Идентификатор уведомления
- type — Тип уведомления. Тип уведомления
- date_init — Дата появления. Дата последнего появления уведомления в системе
- description_local — Описание. Текстовое описание уведомления
- level — Уровень. Уровень уведомления. Может принимать значения: сообщение, предупреждение, ошибка, критическая проблема
- autosolve — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если данное поле отмечено, будут производиться попытки решения проблемы с заданной периодичностью
- autosolve_period — Период (мин.). Период в минутах, через который будут осуществляться попытки решения проблемы
- solvenow — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Если поле активно, то при нажатии на кнопку "ОК" будет произведена попытка решения
- params — Дополнительная информация. Дополнительная информация о проблеме
Удалить уведомление
Функция: problems.delete
Удалить уведомление
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции problems.
Результат: успешное выполнение операции или сообщение об ошибке
Наименование
Функция: problems.log
Результат: список элементов
Лог появления
Уровень доступа: admin+
- date — Дата появления
- owner — Пользователь
- duration — Продолжительность
Установка фильтра.
problems.filter
Физические сети
Функция: ipmgr2.net
Результат: список элементов
Физические сети
Уровень доступа: admin+
- name — Сеть
- note — Примечания
- netmask — Маска сети
- gateway — Шлюз
- usage — Использование адресов
Адрес
Функция: ipmgr2.net.ip
Результат: список элементов
Занятые IP адреса
Уровень доступа: admin+
- name — Адрес
- size — Количество адресов
- domain — Доменное имя
- status — Состояние
- pool — Пул адресов
- note -
Редактирование сети
Функция: ipmgr2.net.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции ipmgr2.net)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции ipmgr2.net)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- name — Сеть. Сеть в формате 12.34.56.0/24 или 2a01:1::/48 для IPv6. Подробности о том что и как будет сконфигурировано смотрите по ссылкам в документацию
- gateway — Шлюз. Адрес шлюза, используется другими продуктами для настройки сети
- firstip — Первый адрес. Первый IP-адрес в указанной сети
- lastip — Последний адрес. Последний IP-адрес в указанной сети
- ipcount — Количество адресов. Количество IP-адресов в указанной сети
- note — Примечания. Произвольное описание сети
Удалить
Функция: ipmgr2.net.delete
Удалить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции ipmgr2.net.
Результат: успешное выполнение операции или сообщение об ошибке
Установка фильтра.
ipmgr2.net.filter
Настройка логирования
Функция: errorjournal.settings
Результат: список элементов
Настройка логирования
Уровень доступа: admin+
- name — Описание
- module — Модуль
- level — Уровень
Настройка логирования
Функция: errorjournal.settings.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент module из функции errorjournal.settings)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент module из функции errorjournal.settings)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- level — Уровень. Уровень определяет насколько детально информация будет отображаться в логах. Чем выше цифра, тем более подробная информация будет записываться в лог-файл
Удалить из конфига настройку логирования для выбранного модуля
Функция: errorjournal.settings.default
Удалить из конфига настройку логирования для выбранного модуля
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент module из функции errorjournal.settings.
Результат: успешное выполнение операции или сообщение об ошибке
Задать для выбранного модуля максимальный уровень логирования
Функция: errorjournal.settings.setmax
Задать для выбранного модуля максимальный уровень логирования
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент module из функции errorjournal.settings.
Результат: успешное выполнение операции или сообщение об ошибке
Настройка бренда
Функция: brandlist
Результат: список элементов
Настройки бренда
Уровень доступа: admin+
- manager — Панель
- domain — Доменное имя
- theme — Тема оформления
- params — Параметры
Настройка бренда
Функция: brandlist.edit
Уровень доступа: admin+
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции brandlist)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции brandlist)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- manager — Панель. Выберите панель, для которой вы желаете изменить внешний вид
- domain_all — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Внешний вид панели может отличаться, в зависимоти от того, какое доменное имя было использовано
- domain — Доменное имя. Введите доменное имя. Настройки внешнего вида будут применены только при обращении к панели через это имя
- h — Тон. Тон цветовой схемы. Значения от -180 до 180
- s — Насыщенность. Насыщенность цветовой схемы. Значения от -100 до 100
- l — Яркость. Яркость цветовой схемы. Значения от -100 до 100
- header — Заголовок окна. Данная строка будет использована в качестве заголовка страницы
- site — Ссылка на логотипе. Адрес, который будет открываться при нажатии на логотоп
- signature — Подпись. Подпись копирайта. Как правило, указывается: знак копирайта, название правообладателя и годы работы компании
- homepage — Домашняя страница. URL домашней страницы компании. Вы можете использовать макрос $lang, вместо которого будет подставлена аббревиатура текущего языка
- contacts — Контакты. Вы можете задать ссылку на контактные данные вашей компамии. Ссылка будет добавлена на форму авторизации. Вы можете использовать макрос $lang, вместо которого будет подставлена аббревиатура текущего языка
- head — Заголовок. Указанный в данном поле код будет добавлен в заголовок (HEAD) каждой страницы
- body — Тело. Указанный в данном поле код будет добавлен в конец тела (BODY) каждой страницы
Удалить
Функция: brandlist.delete
Удалить
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции brandlist.
Результат: успешное выполнение операции или сообщение об ошибке
Сформировать заново картинки и css файлы для всех настроек
Функция: brandlist.fix
Сформировать заново картинки и css файлы для всех настроек
Уровень доступа: admin+
Ведомые серверы
Функция: slaveserver
Результат: список элементов
Ведомые серверы имён
Уровень доступа: registered
- url — URL панели управления
- username — Пользователь
Ведомый сервер имён
Функция: slaveserver.edit
Уровень доступа: registered
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент name из функции slaveserver)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент name из функции slaveserver)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см.выше):
- url — URL панели управления. Укажите полный адрес панели управления DNSmanager ведомого сервера. Например: https://mydns.com:1500/dnsmgr
- username — Пользователь. Укажите имя пользователя для доступа к панели управления на ведомом сервере
- password — Пароль. Укажите пароль для доступа к панели управления на ведомом сервере
- sync — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Создать существующие доменные имена на ведомом сервере
Удалить ведомые серверы имён
Функция: slaveserver.delete
Удалить ведомые серверы имён
Уровень доступа: registered
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент name из функции slaveserver.
Результат: успешное выполнение операции или сообщение об ошибке
Информация о системе
Функция: sysinfo
Результат: список элементов
Информация о системе
Уровень доступа: admin+
- name — Параметр
- value — Значение
Подробная информация по выбранному параметру
Функция: sysinfo.seltype
Подробная информация по выбранному параметру
Уровень доступа: admin+
О программе
Функция: license.info
Уровень доступа: admin+
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- licid — ID лицензии. Уникальный идентификатор лицензии. 0 означает бесплатную лицензию с определенным набором ограничений, которые указаны в верхней части экрана.
- licname — Имя лицензии. Это имя, которое вы выбрали при заказе лицензии, например, ваше имя или название вашей организации
- licdate — Действует до. Дата истечения срока действия лицензии. По истечении срока действия, панель управления прекращает работу
- updateexpiredate — Получение обновлений до. Обновление продукта оплачено до указанной даты
- regemail — Зарегистрировано на. Адрес учетной записи в биллинговой системе ISPmanager, на который зарегистрированна данная лицензия
- panel_name — Панель управления. Панель управления, установленная на сервере
- os — Операционная система. Версия операционной системы, для которой была собрана панель управления
- repository — Репозиторий. Репозиторий для установки обновлений
- mirror — Зеркало. Зеркало, используемое для загрузки файлов данных
- core_info — Версия COREmanager. Версия и дата сборки COREmanager
- panel_info — Версия панели. Версия и дата сборки панели управления
- last_available_version — Последняя доступная версия. Последняя доступная для загрузки версия
Почтовые уведомления
Функция: emailnotify
Уровень доступа: admin+
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- servertype — Тип почтового сервера. Тип почтового сервера через который будут отправляться почтовые уведомления
- smtpserver — Адрес SMTP-сервера. Укажите адрес SMTP-сервера, с которого будет происходит отправка оповещений
- smtpuser — Учетная запись . Укажите имя учетной записи (имя пользователя или полный адрес электронной почты, например, example@mail.com)
- smtppassword — Пароль. Введите пароль
- smtpport — Порт SMTP-сервера. Укажите порт, на котором работает SMTP-сервер, по умолчанию — 25-й порт
- sendername — Имя отправителя. Имя отправителя которое по умолчанию будет добавляться в письма
- servername_param — Имя сервера. Укажите доменное имя сервера, которое будет использоваться в почтовом сообщении
- type_auth — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений об успешной авторизации в панели
- type_geoip — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений модуля отслеживания региона по IP-адресу. Если отключить данную опцию, будет остановлена работа всего модуля GeoIP
- type_recovery — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений модуля восстановления пароля. Если отключить данную опцию, будет остановлена работа всего модуля восстановления пароля
- type_dnssec — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Разрешает отправку уведомлений от расширения DNSSEC dns-сервера.
Модули
Функция: plugin
Уровень доступа: admin+
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
Список изменений
Функция: changelog
Результат: список элементов
Список изменений
Уровень доступа: admin+
- version — Версия
- date — Дата выпуска
- install_date — Дата установки
- count — Количество изменений
- state — Состояние
Установка фильтра.
changelog.filter
Обновить список изменений
Функция: changelog.refresh
Обновить список изменений
Уровень доступа: admin+
Наименование
Функция: changelog.changes
Результат: список элементов
Список изменений версии
Уровень доступа: admin+
- desc — Описание изменения
- type — Тип изменения
- edition — Редакция продукта
Пересобрать панель
Функция: builder.make
Уровень доступа: admin+
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
Активные сессии
Функция: session
Результат: список элементов
Активные сессии
Уровень доступа: admin+
- id — Id сессии
- name — Пользователь
- props — Доступ
- ip — IP адрес
- idle — Ожидание
- count — Активных запросов
Войти в панель с такими же правами
Функция: session.su
Войти в панель с такими же правами
Уровень доступа: admin+
Завершить выбранные сеансы. Для дальнейшей работы с панелью управления пользователь должен будет заново пройти процесс авторизации
Функция: session.delete
Завершить выбранные сеансы. Для дальнейшей работы с панелью управления пользователь должен будет заново пройти процесс авторизации
Уровень доступа: admin+
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции session.
Результат: успешное выполнение операции или сообщение об ошибке
Установка фильтра.
session.filter
Настройки пользователя
Функция: usrparam
Уровень доступа: admin+
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- name — Имя пользователя. Текущее имя пользователя, для которого вы изменяете настройки панели управления
- theme — Тема. Тема панели управления
- lang — Язык. Язык панели управления. Компания ISPmanager осуществила перевод своих программных продуктов с английского на другие языки с привлечением партнеров и не гарантирует исключительной точности переводов. Ко всему прочему программа может содержать текст, перевод которого все еще находится в процессе. Просим сообщать об ошибках в переводе путем выделения проблемного текста и нажатием сочетания клавиш Ctrl+Enter
- old_password — Старый пароль. Старый пароль пользователя. Обязателен для ввода, если хотите сменить пароль
- password — Пароль. Пароль для панели управления. Оставьте это поле пустым, если не хотите менять пароль
- confirm — Подтверждение. Повторите тот же пароль, чтобы убедиться, что ввели его правильно
- atype — Доступ к панели управления. Укажите, с каких IP-адресов вы хотите разрешить доступ к панели управления.Будьте предельно внимательны! Допустив ошибку, возможно, вы не сможете больше попасть в панель управления;
- addr — Список IP-адресов. Укажите список IP-адресов, с которых вы хотите разрешить доступ к панели управления. Можно указать отдельные адреса (123.45.67.89), адреса по маске (123.45.67.0/24), либо диапазон адресов (123.45.67.89-123.45.67.98)
- secureip — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) После регистрации в системе пользователю выдается уникальный идентификатор сессии. По умолчанию, он может быть использован с любого IP. Включив данный параметр, вы разрешаете пользоваться сессией только с того адреса, который был у пользователя при её получении
- startpage — Стартовая страница. Страница, которая будет отображаться первой после того, как вы войдете в систему.
- rows — Строк на странице. Количество строк таблицы, которые будут отображаться на каждой странице, по умолчанию
- recordlimit — Количество записей. Максимальное количество записей, которое будет выведено в список. Ограничение нужно для предотвращения длительного формирования результата на больших объемах данных. Зачастую удобнее воспользоваться фильтром, нежели ожидать формирования большого списка, а потом просматривать его.
- buttonview — Вид кнопок. Выберите предпочитаемое отображение кнопок на панели инструментов
- hintview — Подсказки. Активные подсказки появляются, когда поле получает фокус ввода. Пассивные только при наведении курсора на значок подсказки
- checkunsaved — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Предупреждать о несохраненных полях на форме
- email — Email. Укажите Email, на который будут приходить оповещения
- page_actions — Страница.
- vkontakte_status — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Привязать данный аккаунт к аккаунту Вконтакте. Чтобы отвязать: необходимо снять галочку и сохранить форму
- facebook_status — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Привязать данный аккаунт к аккаунту Facebook. Чтобы отвязать: необходимо убрать галочку и сохранить форму
- google_status — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Привязать данный аккаунт к аккаунту Google. Чтобы отвязать: необходимо убрать галочку и сохранить форму
- disable_totp — Отключить двухэтапную аутентификацию. Для отключения двухэтапной аутентификации введите 6-значный числовой пароль, сгенерированный приложением Google Authenticator
Интеграция с IPmanager
Функция: ipmgr
Уровень доступа: admin+
Данная функция одновременно используется для просмотра и изменения данных формы
Просмотр данных:
- Результат: список параметров
Изменение данных:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров или дополнительных параметров запроса (см.выше):
- useipmgr — . (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Активировать интеграцию с IPmanager, централизованной базы IP-адресов
- url — IPmanager URL. Адрес сервера с IPmanager
- login — Имя пользователя. Имя пользователя для доступа к IPmanager
- password — Пароль. Пароль пользователя для доступа к IPmanager