fortinet.fortimanager.fmgr_securityconsole_abort – Прерывание и отмена задачи консоли безопасности.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_securityconsole_abort.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием в источниках данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только в том случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed list / elements=string | список кодов rc, при которых будут нарушены условия для завершения с ошибкой | ||
| rc_succeeded list / elements=string | список кодов rc, при которых будут нарушены условия для успешного завершения | ||
| securityconsole_abort dictionary | параметры верхнего уровня | ||
| adom string | Имя источника ADOM. | ||
| workspace_locking_adom string | ADOM для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая корневой. | ||
| workspace_locking_timeout integer | По умолчанию: 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: Abort and cancel a security console task.
fmgr_securityconsole_abort:
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, ...]
securityconsole_abort:
adom: <value of string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url string | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code integer | всегда | Статус запроса API |
| response_message string | всегда | Дескриптивное сообщение ответа 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_securityconsole_abort_module.html
