fortinet.fortimanager.fmgr_firewall_schedule_onetime модуль — Настройка расписания на один раз.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
У вас, возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_schedule_onetime.
Новое в fortinet.fortimanager 2.0.0
Описание
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в значение True только в случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_schedule_onetime словарь | Настройка параметров верхнего уровня. |
|
color целое число |
Цвет значка на графическом интерфейсе. |
|
end строка |
Дата и время окончания расписания, формат чч |
|
end-utc строка |
Устарело, пожалуйста, переименуйте на end_utc. Дата и время окончания расписания в формате эпохи. |
|
expiration-days целое число |
Устарело, пожалуйста, переименуйте на expiration_days. Запись сообщения в журнал событий за столько дней до истечения срока действия расписания. |
|
fabric-object строка |
Устарело, пожалуйста, переименуйте на fabric_object. Настройка глобального объекта Security Fabric. Варианты:
|
|
global-object целое число |
Устарело, пожалуйста, переименуйте на global_object. Глобальный объект. |
|
name строка / обязательно |
Имя одноразового расписания. |
|
start строка |
Дата и время начала расписания, формат чч |
|
start-utc строка |
Устарело, пожалуйста, переименуйте на start_utc. Дата и время начала расписания в формате эпохи. |
|
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: Onetime schedule configuration.
fortinet.fortimanager.fmgr_firewall_schedule_onetime:
bypass_validation: false
adom: ansible
state: present
firewall_schedule_onetime:
color: 1
end: "15:00 2020/08/17"
name: "ansible-test-onetime"
start: "07:00 2020/08/17"
- 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 onetime schedules
fortinet.fortimanager.fmgr_fact:
facts:
selector: "firewall_schedule_onetime"
params:
adom: "ansible"
onetime: "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_onetime_module.html
