fortinet.fortimanager.fmgr_firewall_address – Настройка адресов IPv4.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 1.0.5).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_firewall_address.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager, позволяя пользователю [ добавить получить установить обновить ] следующие API.
- /pm/config/adom/{adom}/obj/firewall/address
- /pm/config/global/obj/firewall/address
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| loose_validation boolean |
| Проверка параметров в свободном режиме |
| method строка / обязательный |
| Метод запроса |
| params список / элементы=строка | Параметры для каждого метода Полный список параметров см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest | |
| url_params словарь | Параметры для каждого URL-адреса API-запроса Полный список параметров URL также см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest | |
| workspace_locking_adom строка | Имя домена для блокировки в случае работы FortiManager в режиме рабочей области Может быть глобальным или любым другим настраиваемым именем домена | |
| workspace_locking_timeout целое число | По умолчанию: 300 | Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочей области |
Примечания
Примечание
- Существуют только три параметра верхнего уровня, где ‘method’ всегда требуется, а остальные два ‘params’ и ‘url_params’ могут быть необязательными
- Из-за сложности схемы API fortimanager проверка выполняется за пределами стандартной процедуры проверки параметров Ansible.
- Синтаксис OPTIONS не соответствует стандартному спецификации аргументов Ansible, но в соответствии со структурой схемы API fortimanager нам нужно тривиальное преобразование, когда мы заполняем книгу задач ansible
Примеры
- 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: REQUESTING /PM/CONFIG/OBJ/FIREWALL/ADDRESS
fmgr_firewall_address:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [add, set, update]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
data:
-
allow-routing: <value in [disable, enable]>
associated-interface: <value of string>
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of string>
country: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
allow-routing: <value in [disable, enable]>
associated-interface: <value of string>
cache-ttl: <value of integer>
color: <value of integer>
comment: <value of string>
country: <value of string>
end-ip: <value of string>
end-mac: <value of string>
epg-name: <value of string>
filter: <value of string>
fqdn: <value of string>
interface: <value of string>
obj-id: <value of string>
organization: <value of string>
policy-group: <value of string>
sdn: <value in [aci, aws, nsx, ...]>
sdn-addr-type: <value in [private, public, all]>
sdn-tag: <value of string>
start-ip: <value of string>
start-mac: <value of string>
subnet: <value of string>
subnet-name: <value of string>
tags: <value of string>
tenant: <value of string>
type: <value in [ipmask, iprange, fqdn, ...]>
url: <value of string>
uuid: <value of string>
visibility: <value in [disable, enable]>
wildcard: <value of string>
wildcard-fqdn: <value of string>
end-ip: <value of string>
epg-name: <value of string>
filter: <value of string>
fqdn: <value of string>
list:
-
ip: <value of string>
name: <value of string>
obj-id: <value of string>
organization: <value of string>
policy-group: <value of string>
sdn: <value in [aci, aws, nsx, ...]>
sdn-tag: <value of string>
start-ip: <value of string>
subnet: <value of string>
subnet-name: <value of string>
tagging:
-
category: <value of string>
name: <value of string>
tags:
- <value of string>
tenant: <value of string>
type: <value in [ipmask, iprange, fqdn, ...]>
uuid: <value of string>
visibility: <value in [disable, enable]>
wildcard: <value of string>
wildcard-fqdn: <value of string>
- name: REQUESTING /PM/CONFIG/OBJ/FIREWALL/ADDRESS
fmgr_firewall_address:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
attr: <value of string>
fields:
-
- <value in [allow-routing, associated-interface, cache-ttl, ...]>
filter:
- <value of string>
get used: <value of integer>
loadsub: <value of integer>
option: <value in [count, object member, datasrc, ...]>
range:
- <value of integer>
sortings:
-
varidic.attr_name: <value in [1, -1]>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| data словарь | всегда | Загрузка, возвращенная в запросе |
| status словарь | всегда | Состояние запроса к API |
| url строка | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
Авторы
- Frank Shen (@fshen01)
- Link Zheng (@zhengl)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortimanager/fmgr_firewall_address_module.html
