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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_firewall_multicastaddress_obj.

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область

Примечания

Примечание

Существует только три параметра верхнего уровня, где «метод» всегда обязателен, а два других «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/{MULTICAST-ADDRESS}
     fmgr_firewall_multicastaddress_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]>
           multicast-address: <value of string>
        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/{MULTICAST-ADDRESS}
     fmgr_firewall_multicastaddress_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]>
           multicast-address: <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_multicastaddress_obj_module.html