fortinet.fortimanager.fmgr_firewall_ippool_obj – Настройка IP-пулов IPv4.

Примечание

Этот плагин входит в состав коллекции fortinet.fortimanager (версия 1.0.5).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_firewall_ippool_obj

Новое в версии 2.10: of fortinet.fortimanager

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль может настроить устройство FortiManager, позволив пользователю [ клонировать, удалить, получить, установить, обновить ] следующие API:
/pm/config/adom/{adom}/obj/firewall/ippool/{ippool}
/pm/config/global/obj/firewall/ippool/{ippool}
Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется свободно
method строка / обязательный	Варианты: clone delete get set update	Метод запроса
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/IPPOOL/{IPPOOL}
     fmgr_firewall_ippool_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [clone, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           ippool: <value of string>
        params:
           -
              data:
                 arp-intf: <value of string>
                 arp-reply: <value in [disable, enable]>
                 associated-interface: <value of string>
                 block-size: <value of integer>
                 comments: <value of string>
                 dynamic_mapping:
                   -
                       _scope:
                         -
                             name: <value of string>
                             vdom: <value of string>
                       arp-intf: <value of string>
                       arp-reply: <value in [disable, enable]>
                       associated-interface: <value of string>
                       block-size: <value of integer>
                       comments: <value of string>
                       endip: <value of string>
                       num-blocks-per-user: <value of integer>
                       pba-timeout: <value of integer>
                       permit-any-host: <value in [disable, enable]>
                       source-endip: <value of string>
                       source-startip: <value of string>
                       startip: <value of string>
                       type: <value in [overload, one-to-one, fixed-port-range, ...]>
                 endip: <value of string>
                 name: <value of string>
                 num-blocks-per-user: <value of integer>
                 pba-timeout: <value of integer>
                 permit-any-host: <value in [disable, enable]>
                 source-endip: <value of string>
                 source-startip: <value of string>
                 startip: <value of string>
                 type: <value in [overload, one-to-one, fixed-port-range, ...]>

   - name: REQUESTING /PM/CONFIG/OBJ/FIREWALL/IPPOOL/{IPPOOL}
     fmgr_firewall_ippool_obj:
        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]>
           ippool: <value of string>
        params:
           -
              option: <value in [object member, chksum, datasrc]>

Возвращаемые значения

Общие возвращаемые значения описаны в здесь, а следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
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_ippool_obj_module.html