fortinet.fortimanager.fmgr_firewall_multicastaddress – Настройка адресов мультикаста.

Примечание

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

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

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

Добавлено в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется свободным способом
method string / required	Варианты: add get set update	Метод запроса
params list / elements=string		Параметры для каждого метода Полный список параметров см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params dictionary		Параметры для каждого URL запроса API Полный список параметров URL также см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom string		Имя домена для блокировки в случае работы FortiManager в режиме рабочего пространства Может быть глобальным или любым другим именем настраиваемого домена
workspace_locking_timeout integer	Значение по умолчанию: 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/MULTICAST-ADDRESS
     fmgr_firewall_multicastaddress:
        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:
                -
                    associated-interface: <value of string>
                    color: <value of integer>
                    comment: <value of string>
                    end-ip: <value of string>
                    name: <value of string>
                    start-ip: <value of string>
                    subnet: <value of string>
                    tagging:
                      -
                          category: <value of string>
                          name: <value of string>
                          tags:
                            - <value of string>
                    type: <value in [multicastrange, broadcastmask]>
                    visibility: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/OBJ/FIREWALL/MULTICAST-ADDRESS
     fmgr_firewall_multicastaddress:
        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 [associated-interface, color, comment, ...]>
              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 dictionary	всегда	Полезная нагрузка, возвращаемая в запросе
status dictionary	всегда	Статус запроса API
url string	всегда	Полный запрашиваемый 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_multicastaddress_module.html