fortinet.fortimanager.fmgr_dvmdb_script_scriptschedule – Расписание скрипта.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvmdb_script_scriptschedule.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логический |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| dvmdb_script_scriptschedule словарь | параметры верхнего уровня | ||
| datetime строка | Указывает дату и время расписания. Следует использовать следующий формат для каждого типа планирования: onetime: "ГГГГ-ММ-ДД чч:мм:сс" daily: "чч:мм" weekly: "чч:мм" monthly: "ДД чч:мм" | ||
| day_of_week строка |
| нет описания | |
| device целое число | Имя или идентификатор существующего устройства в базе данных. | ||
| name строка | нет описания | ||
| run_on_db строка |
| Указывает, должен ли запланированный скрипт выполняться в базе данных устройства. Для скриптов TCL это значение должно всегда быть выключено. | |
| type строка |
| нет описания | |
| rc_failed список / элементы=строка | список кодов rc, по которым условие ошибки будет переопределено | ||
| rc_succeeded список / элементы=строка | список кодов rc, по которым условие успеха будет переопределено | ||
| script строка / обязательно | параметр (script) в запрошенном URL | ||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |
| workspace_locking_adom строка | область домена для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корень | ||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем | |
Примечания
Примечание
- Поддержка работы в режиме блокировки рабочего пространства в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте указание state present.
- Для удаления объекта используйте указание state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код rc. Вы также можете переопределить условия ошибки или успеха с помощью параметров rc_failed и rc_succeeded.
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Script schedule table.
fmgr_dvmdb_script_scriptschedule:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
script: <your own value>
state: <value in [present, absent]>
dvmdb_script_scriptschedule:
datetime: <value of string>
day_of_week: <value in [unknown, sun, mon, ...]>
device: <value of integer>
name: <value of string>
run_on_db: <value in [disable, enable]>
type: <value in [auto, onetime, daily, ...]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрос URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Описание ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_dvmdb_script_scriptschedule_module.html
