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

Примечание

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

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

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

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

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

Обзор

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL
bypass_validation булево			Варианты: нет ← да	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров.
firewall_multicastaddress словарь				Параметры верхнего уровня.
	associated-interface строка			Интерфейс, связанный с объектом адреса. При настройке политики доступны только адреса, связанные с этим интерфейсом. ...
	color целое число			Целое число для определения цвета значка в графическом интерфейсе (1–32, по умолчанию 0, что устанавливает значение в 1).
	comment строка			Комментарий.
	end-ip строка			Конечный IPv4-адрес (включительно) в диапазоне для адреса.
	name строка			Имя адреса мультикаста.
	start-ip строка			Первый IPv4-адрес (включительно) в диапазоне для адреса.
	subnet строка			Адрес широковещательной рассылки и подсеть.
	tagging список / элементы=строка			Без описания.
		category строка		Категория тега.
		name строка		Имя записи тегирования.
		tags строка		Без описания.
	type строка		Варианты: multicastrange broadcastmask	Тип объекта адреса: диапазон IP-адресов мультикаста или IP-адрес/маска широковещательной рассылки, обрабатываемый как адрес мультикаста.
	visibility строка		Варианты: disable enable	Включить/выключить видимость адреса мультикаста в графическом интерфейсе.
rc_failed список / элементы=строка				Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=строка				Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно			Варианты: present absent	Директива для создания, обновления или удаления объекта.
workspace_locking_adom строка				ADOM для блокировки в режиме работы в рамках рабочей области для FortiManager, значение может быть глобальным и другими, включая root.
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: Configure multicast addresses.
     fmgr_firewall_multicastaddress:
        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>
        state: <value in [present, absent]>
        firewall_multicastaddress:
           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]>

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

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

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