Модуль fortinet.fortimanager.fmgr_pkg_firewall_multicastpolicy — настройка политик многоадресного NAT.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_pkg_firewall_multicastpolicy.

Добавлено в fortinet.fortimanager 2.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
pkg string / обязательный	Параметр (pkg) в запрашиваемом URL.
pkg_firewall_multicastpolicy dictionary	Набор параметров верхнего уровня.
action string	Разрешить или запретить трафик, соответствующий политике. Варианты: `"deny"` `"accept"`
auto_asic_offload псевдонимы: auto-asic-offload string	Включить или отключить аппаратное ускорение трафика политики. Варианты: `"disable"` `"enable"`
comments string	Комментарий.
dnat string	IPv4-адрес DNAT, используемый для адресов назначения многоадресной рассылки.
dstaddr any	(список или строка) Объекты адресов назначения.
dstintf string	Имя интерфейса назначения.
end_port псевдонимы: end-port integer	Целочисленное значение конечного порта назначения TCP/UDP/SCTP в диапазоне.
id integer / обязательный	Идентификатор политики.
ips_sensor псевдонимы: ips-sensor string	Имя существующего датчика IPS.
logtraffic string	Включить или отключить регистрацию трафика, разрешённого этой политикой. Варианты: `"disable"` `"enable"` `"all"` `"utm"`
name string	Имя политики.
protocol integer	Целочисленное значение типа протокола согласно определению IANA.
snat string	Включить или отключить подстановку IP-адреса исходящего интерфейса вместо исходного IP-адреса источника. Варианты: `"disable"` `"enable"`
snat_ip псевдонимы: snat-ip string	IPv4-адрес, используемый в качестве адреса источника для трафика с NAT.
srcaddr any	(список или строка) Объекты адресов источника.
srcintf string	Имя интерфейса источника.
start_port псевдонимы: start-port integer	Целочисленное значение начального порта назначения TCP/UDP/SCTP в диапазоне.
status string	Включить или отключить эту политику. Варианты: `"disable"` `"enable"`
traffic_shaper псевдонимы: traffic-shaper string	Формирователь трафика, применяемый к трафику, пересылаемому политикой многоадресной рассылки.
utm_status псевдонимы: utm-status string	Включить добавление профиля безопасности IPS к политике. Варианты: `"disable"` `"enable"`
uuid string	Универсальный уникальный идентификатор.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия возникновения ошибки.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Инструкция для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM для блокировки в FortiManager, работающем в режиме рабочей области. Значением может быть global и другие варианты, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0 все входные аргументы именуются в соответствии с соглашением об использовании подчёркиваний (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает режим блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля может завершиться ошибкой при возврате ненулевого rc. Условия возникновения ошибки или успешного выполнения можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure multicast NAT policies.
      fortinet.fortimanager.fmgr_pkg_firewall_multicastpolicy:
        bypass_validation: false
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_multicastpolicy:
          action: accept # <value in [deny, accept]>
          dstaddr: all
          dstintf: any
          id: 2
          srcaddr: all
          srcintf: any
          status: disable

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the multicast NAT policies
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "pkg_firewall_multicastpolicy"
          params:
            adom: "ansible"
            pkg: "ansible" # package name
            multicast_policy: "your_value"

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный запрошенный URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: при определённых условиях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_pkg_firewall_multicastpolicy_module.html