fortinet.fortimanager.fmgr_system_guiact – Настройка системы через графический интерфейс.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_system_guiact.
Добавлено в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, по которым будут переопределены условия завершения с ошибкой | ||
| rc_succeeded список / элементы=строка | список кодов rc, по которым будут переопределены условия успешного завершения | ||
| state строка / обязательный |
| директива для создания, обновления или удаления объекта | |
| system_guiact словарь | параметры верхнего уровня | ||
| backup_all строка | Архивировать все настройки. | ||
| backup_conf строка | Архивировать файл конфигурации. | ||
| eventlog_msg строка | Записать в журнал событий. | ||
| eventlog_path строка | Путь к журналу событий. | ||
| reboot целое число | По умолчанию: 0 | Перезагрузить систему. | |
| reset2default целое число | По умолчанию: 0 | Сбросить до заводских настроек. | |
| restore_all строка | Восстановить все настройки. | ||
| restore_conf строка | Восстановить файл конфигурации. | ||
| time строка | Время. | ||
| 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: System settings through GUI.
fmgr_system_guiact:
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, ...]
system_guiact:
backup_all: <value of string>
backup_conf: <value of string>
eventlog_msg: <value of string>
eventlog_path: <value of string>
reboot: <value of integer>
reset2default: <value of integer>
restore_all: <value of string>
restore_conf: <value of string>
time: <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_system_guiact_module.html
