Модуль fortinet.fortios.fortios_router_policy — настройка политик маршрутизации IPv4 в FortiOS и FortiGate от Fortinet.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_router_policy.

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

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

Обзор

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функций и политик маршрутизатора. Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0

Требования

На хосте, где выполняется этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log логический	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, разделяйте их символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над элементом.
member_state строка	Добавить или удалить элемент по указанному пути атрибута. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
router_policy словарь	Настройка политик маршрутизации IPv4.
action строка	Действие политики маршрутизации. Варианты: `"deny"` `"permit"`
comments строка	Необязательные комментарии.
dst список / элементы=словарь	IP-адрес назначения и маска (x.x.x.x/x).
subnet строка / обязательный	IP-адрес и маска.
dst_negate строка	Включить/отключить инверсию совпадения адреса назначения. Варианты: `"enable"` `"disable"`
dstaddr список / элементы=словарь	Имя адреса назначения.
name строка / обязательный	Имя адреса/группы. Источник: firewall.address.name, firewall.addrgrp.name.
end_port целое число	Номер конечного порта назначения (0–65535).
end_source_port целое число	Номер конечного порта источника (0–65535).
gateway строка	IP-адрес шлюза.
groups список / элементы=словарь	Список групп пользователей.
name строка / обязательный	Имя группы. Источник: user.group.name.
input_device список / элементы=словарь	Имя входящего интерфейса.
name строка / обязательный	Имя интерфейса. Источник: system.interface.name.
input_device_negate строка	Включить/отключить инверсию совпадения входящего устройства. Варианты: `"enable"` `"disable"`
internet_service_custom список / элементы=словарь	Имя пользовательской службы назначения в Интернете.
name строка / обязательный	Имя пользовательской службы назначения в Интернете. Источник: firewall.internet-service-custom.name.
internet_service_fortiguard список / элементы=словарь	Имя службы назначения FortiGuard в Интернете.
name строка / обязательный	Имя службы назначения FortiGuard в Интернете. Источник: firewall.internet-service-fortiguard.name.
internet_service_id список / элементы=словарь	Идентификатор службы назначения в Интернете.
id целое число / обязательный	Идентификатор службы назначения в Интернете. См. <a href=’#notes’>Примечания</a>. Источник: firewall.internet-service.id.
output_device строка	Имя исходящего интерфейса. Источник: system.interface.name.
protocol целое число	Номер протокола (0–255).
seq_num целое число / обязательный	Порядковый номер (1–65535). См. <a href=’#notes’>Примечания</a>.
src список / элементы=словарь	IP-адрес источника и маска (x.x.x.x/x).
subnet строка / обязательный	IP-адрес и маска.
src_negate строка	Включить/отключить инверсию совпадения адреса источника. Варианты: `"enable"` `"disable"`
srcaddr список / элементы=словарь	Имя адреса источника.
name строка / обязательный	Имя адреса/группы. Источник: firewall.address.name, firewall.addrgrp.name.
start_port целое число	Номер начального порта назначения (0–65535).
start_source_port целое число	Номер начального порта источника (0–65535).
status строка	Включить/отключить эту политику маршрутизации. Варианты: `"enable"` `"disable"`
tos строка	Шаблон битов типа обслуживания.
tos_mask строка	Биты типа обслуживания, используемые для проверки.
users список / элементы=словарь	Список пользователей.
name строка / обязательный	Имя пользователя. Источник: user.local.name.
state строка / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom строка	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Настоятельно рекомендуем указывать собственное значение seq_num вместо 0. Значение «0» — это специальный заполнитель, который позволяет серверной части назначить объекту последний доступный номер, однако у этого подхода есть ограничения. Дополнительные сведения см. в разделе «Вопросы и ответы».
Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi.
Модуль поддерживает check_mode.

Примеры

- name: Configure IPv4 routing policies.
  fortinet.fortios.fortios_router_policy:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_policy:
          action: "deny"
          comments: "<your_own_value>"
          dst:
              -
                  subnet: "<your_own_value>"
          dst_negate: "enable"
          dstaddr:
              -
                  name: "default_name_9 (source firewall.address.name firewall.addrgrp.name)"
          end_port: "65535"
          end_source_port: "65535"
          gateway: "<your_own_value>"
          groups:
              -
                  name: "default_name_14 (source user.group.name)"
          input_device:
              -
                  name: "default_name_16 (source system.interface.name)"
          input_device_negate: "enable"
          internet_service_custom:
              -
                  name: "default_name_19 (source firewall.internet-service-custom.name)"
          internet_service_fortiguard:
              -
                  name: "default_name_21 (source firewall.internet-service-fortiguard.name)"
          internet_service_id:
              -
                  id: "23 (source firewall.internet-service.id)"
          output_device: "<your_own_value> (source system.interface.name)"
          protocol: "0"
          seq_num: "<you_own_value>"
          src:
              -
                  subnet: "<your_own_value>"
          src_negate: "enable"
          srcaddr:
              -
                  name: "default_name_31 (source firewall.address.name firewall.addrgrp.name)"
          start_port: "0"
          start_source_port: "0"
          status: "enable"
          tos: "<your_own_value>"
          tos_mask: "<your_own_value>"
          users:
              -
                  name: "default_name_38 (source user.local.name)"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи данных в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат выполнения операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

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

© 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/fortios/fortios_router_policy_module.html