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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.15

Параметры

Параметр	Комментарии
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 строка / обязательный	Имя адреса/группы. Источник брандмауэр.адрес.имя брандмауэр.адргр.имя.
end_port целое число	Номер конечного порта назначения (0-65535).
end_source_port целое число	Номер конечного порта источника (0-65535).
gateway строка	IP-адрес шлюза.
input_device список / элементы=словарь	Имя входящего интерфейса.
name строка / обязательный	Имя интерфейса. Источник система.интерфейс.имя.
input_device_negate строка	Включить/выключить отмену соответствия входящему устройству. Выбор: `"enable"` `"disable"`
internet_service_custom список / элементы=словарь	Настраиваемое имя внешнего сервиса назначения.
name строка / обязательный	Настраиваемое имя внешнего сервиса назначения. Источник брандмауэр.внешний-сервис-настройка.имя.
internet_service_id список / элементы=словарь	ID внешнего сервиса назначения.
id целое число / обязательный	ID внешнего сервиса назначения. см. <a href=’#notes’>Примечания</a>. Источник брандмауэр.внешний-сервис.id.
output_device строка	Имя исходящего интерфейса. Источник система.интерфейс.имя.

END_OF_DOCUMENT_MARKER

protocol integer	Номер протокола (0 - 255).
seq_num integer / обязательно	Номер последовательности (1-65535). см.
src список / элементы=словарь	IP-адрес и маска источника (x.x.x.x/x).
subnet строка / обязательно	IP-адрес и маска.
src_negate строка	Включить/выключить инвертирование совпадения адреса источника. Варианты: `"enable"` `"disable"`
srcaddr список / элементы=словарь	Имя адреса источника.
name строка / обязательно	Имя адреса или группы. Адрес брандмауэра источника. имя firewall.address. имя firewall.addrgrp.
start_port целое число	Начальный номер порта назначения (0 - 65535).
start_source_port целое число	Начальный номер порта источника (0 - 65535).
status строка	Включить/выключить эту маршрутную политику. Варианты: `"enable"` `"disable"`
tos строка	Шаблон бита типа обслуживания.
tos_mask строка	Оцениваемые биты типа обслуживания.
state строка / обязательно	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom строка	Виртуальная область (vdom), определённая ранее. Vdom — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельный блок. По умолчанию: `"root"`

Примечания

Примечание

Сильно рекомендуется использовать собственное значение в качестве seq_num вместо 0, так как «0» — это специальный заполнитель, который позволяет бэкенду назначить последний доступный номер объекта, но у него есть ограничения. Более подробные сведения см. в разделе «Вопросы и ответы».
Модуль httpapi является предпочтительным способом запуска playbooks по сравнению с устаревшим fortiosapi.
Модуль поддерживает режим 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>"
          input_device:
              -
                  name: "default_name_14 (source system.interface.name)"
          input_device_negate: "enable"
          internet_service_custom:
              -
                  name: "default_name_17 (source firewall.internet-service-custom.name)"
          internet_service_id:
              -
                  id: "19 (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_27 (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>"

Значения возврата

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

Ключ	Описание
build строка	Номер сборки образа fortigate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, используемый для предоставления содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, предоставленный FortiGate при последнем примененном действии Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: `"id"`
name строка	Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь таблицы, используемой для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_router_policy_module.html