Документация BILLmanager 6

Планировщик (scheduler)

scheduler

Результат: список элементов

Планировщик

Уровень доступа: root

ПараметрЗначение
command Команда
interval Период
schedule_type Расписание
state Статус
description Описание

Восстановление

Функция: scheduler.prop

Уровень доступа: root

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент key из функции scheduler)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент key из функции scheduler)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
mailto Адрес e-mail для отправки отчетов о выполнении заданий
path Пути поиска исполняемых файлов. Пути разделяются двоеточием

Выполнить задание сейчас

Функция: run

Уровень доступа: root

Удалить

Функция: scheduler.delete

Уровень доступа: root

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции scheduler.

Результат: успешное выполнение операции или сообщение об ошибке

Задание

Функция: scheduler.edit

Уровень доступа: root

Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.

Просмотр параметров объекта:

  • Параметры:
    • elid — уникальный идентификатор (элемент key из функции scheduler)
  • Результат: список параметров объекта

Создание объекта:

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Изменение объекта

  • Параметры:
    • sok — значение параметра должно быть не пустым, обычно "ok".
    • elid — уникальный идентификатор (элемент key из функции scheduler)
    • дополнительные параметры запроса ...
  • Результат: успешное выполнение операции или сообщение об ошибке

Список параметров объекта или дополнительных параметров запроса (см. выше):

ПараметрЗначение
mailto Адрес e-mail можно указать в настройках планировщика
command Команда, выполняемая по расписанию
description Произвольное описание задания
active (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Задание будет выполняться в заданное время, если оно включено
schedule_type Расписание можно настроить как в базовом режиме, выбрав из предложенных вариантов, так и в экспертном режиме, введя соответствующие значения
run_every Период выполнения задания
time_hour Выполнить в. Часы и минуты начала выполнения задания
time_min Часы и минуты начала выполнения задания
wday1 (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы запускать задание каждый понедельник
wday2(Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы запускать задание каждый вторник
wday3 (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы запускать задание каждую среду
wday4 (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы запускать задание каждый четверг
wday5 (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы запускать задание каждую пятницу
wday6 (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы запускать задание каждую субботу
wday0 (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отметьте, чтобы запускать задание каждое воскресенье
month Месяц выполнения задания
month_day День месяца. Число месяца, в которое будет выполняться задание
input_min Минуты. Формат: * — все минуты; */n — каждые n минут; n — с началом минуты n; a,b,c-e — с началом минут a,b,c,d,e
input_hour Часы. Формат: * — все часы; */n — каждые n часов; n — с началом часа n; a,b,c-e — с началом часа a,b,c,d,e
input_dmonth Дни месяцев. Формат: * — все дни месяца; */n — каждые n-й день месяца; n — с началом n-го дня месяца; a,b,c-e — с началом дня номер a,b,c,d,e
input_month Месяцы. Формат: * — все месяцы; */n — каждые n-й месяц; n — с началом n-го месяца; a,b,c-e — с началом месяца номер a,b,c,d,e
input_dweek Дни недели. Формат: * — все дни недели; */n — каждые n-й день недели; n — с началом n-го дня недели; a,b,c-e — с началом дня недели номер a,b,c,d,e (0 — воскресенье)
hideout (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Скрыть результат выполнения команды, отчет не будет отправляться на e-mail, указанный в параметрах планировщика

Выключить

Функция: scheduler.suspend

Уровень доступа: root

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции scheduler.

Результат: успешное выполнение операции или сообщение об ошибке

Включить

Функция: scheduler.resume

Уровень доступа: root

Параметры:

  • elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент key из функции scheduler.

Результат: успешное выполнение операции или сообщение об ошибке