fortinet.fortimanager.fmgr_firewall_schedule_recurring модуль — Настройка расписания повторяющихся заданий.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_schedule_recurring.
Новое в fortinet.fortimanager 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для использования с источниками данных.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_schedule_recurring словарь | Настройка верхнего уровня параметров. |
|
color целое число |
Цвет значка на графическом интерфейсе. |
|
day список / элементы=строка |
Один или несколько дней недели, в которые расписание действует. Варианты:
|
|
end строка |
Время окончания расписания, формат чч |
|
fabric-object строка |
Устаревший параметр, переименуйте на fabric_object. Настройка глобального объекта Security Fabric. Варианты:
|
|
global-object целое число |
Устаревший параметр, переименуйте на global_object. Глобальный объект. |
|
name строка / обязательно |
Имя расписания повторения. |
|
start строка |
Время начала расписания, формат чч |
|
uuid строка |
Универсальный уникальный идентификатор |
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, при которых условия будут игнорироваться. |
rc_succeeded список / элементы=целое число | Список кодов rc, при которых условия будут выполняться. |
state строка / обязательно | Направление для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | Область, которая будет заблокирована для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют название по соглашению snake_case. Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов всё ещё доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
- В этом модуле FortiManager поддерживается режим блокировки рабочей области. Параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия завершения успехом или ошибкой с помощью параметров rc_failed и rc_succeeded
Примеры
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Recurring schedule configuration.
fortinet.fortimanager.fmgr_firewall_schedule_recurring:
bypass_validation: false
adom: ansible
state: present
firewall_schedule_recurring:
color: 1
day:
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- none
end: "15:00"
name: "ansible-test-recurring"
start: "07:00"
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the recurring schedles
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_schedule_recurring"
params:
adom: "ansible"
recurring: "your_value"
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращаемое значение: всегда |
|
request_url строка |
Полный URL запроса. Возвращаемое значение: всегда Пример: |
|
response_code целое число |
Статус API запроса. Возвращаемое значение: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращаемое значение: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращаемое значение: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращаемое значение: всегда |
rc целое число | Статус запроса. Возвращаемое значение: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращаемое значение: сложное |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_schedule_recurring_module.html
