fortinet.fortimanager.fmgr_firewall_address_list – Список IP-адресов.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_address_list.
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address строка / обязательный | параметр (address) в запрошенном URL | ||
| adom строка / обязательный | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается только в значение True, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |
| firewall_address_list словарь | параметры верхнего уровня | ||
| ip строка | IP-адрес. | ||
| 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: IP address list.
fmgr_firewall_address_list:
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>
address: <your own value>
state: <value in [present, absent]>
firewall_address_list:
ip: <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_address_list_module.html
