fortinet.fortimanager.fmgr_firewall_schedule_onetime – Настройка расписания разового выполнения.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook, укажите: fortinet.fortimanager.fmgr_firewall_schedule_onetime.
В версии 2.10: of fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое |
| устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| firewall_schedule_onetime словарь | параметры верхнего уровня | ||
| color целое число | Цвет значка на графическом интерфейсе. | ||
| end строка | Дата и время окончания расписания, формат чч:мм гггг/мм/дд. | ||
| expiration-days целое число | Записать сообщение в журнал событий за столько дней до истечения срока действия расписания. | ||
| name строка | Название расписания разового выполнения. | ||
| start строка | Дата и время начала расписания, формат чч:мм гггг/мм/дд. | ||
| rc_failed список / элементы=строка | список rc-кодов, по которым условие выполнения будет считаться проваленным | ||
| rc_succeeded список / элементы=строка | список rc-кодов, по которым условие выполнения будет считаться выполненным | ||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |
| workspace_locking_adom строка | 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: Onetime schedule configuration.
fmgr_firewall_schedule_onetime:
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_onetime:
color: <value of integer>
end: <value of string>
expiration-days: <value of integer>
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_onetime_module.html
