fortinet.fortimanager.fmgr_firewall_schedule_recurring – Настройка повторяющегося расписания.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_schedule_recurring.
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливать только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| firewall_schedule_recurring словарь | настроеные параметры верхнего уровня | ||
| color целое число | Цвет значка на веб-интерфейсе. | ||
| day список / элементы=строка |
| нет описания | |
| end строка | Время окончания расписания, формат чч:мм. | ||
| name строка | Имя расписания. | ||
| start строка | Время начала расписания, формат чч:мм. | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут считаться выполненными с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут считаться выполненными успешно | ||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |
| workspace_locking_adom строка | adom для блокировки для FortiManager, работающего в режиме рабочей области, значение может быть global и другими, включая root | ||
| 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: Recurring schedule configuration.
fmgr_firewall_schedule_recurring:
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>
state: <value in [present, absent]>
firewall_schedule_recurring:
color: <value of integer>
day:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- none
end: <value of string>
name: <value of string>
start: <value of string>
Возвращаемые значения
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_firewall_schedule_recurring_module.html
