Spec-Zone.ru › Ansible

fortinet.fortios.fortios_router_static модуль — Настройка статических таблиц маршрутизации IPv4 на устройствах Fortinet FortiOS и FortiGate.

Примечание

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

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

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

Для использования в книге задач необходимо указать: fortinet.fortios.fortios_router_static.

Новое в 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_static

словарь

Настройка таблиц статической маршрутизации IPv4.

bfd

строка

Включить/выключить двустороннее обнаружение потери связи (BFD).

Выбор:

  • "enable"
  • "disable"

blackhole

строка

Включить/выключить черную дыру.

Выбор:

  • "enable"
  • "disable"

comment

строка

Дополнительные комментарии.

device

строка

Внешний интерфейс шлюза или туннель. Имя интерфейса источника системы.

distance

целое число

Административная дистанция (1 - 255).

dst

строка

IP-адрес и маска назначения для этого маршрута.

dstaddr

строка

Имя адреса или группы адресов брандмауэра. Имя адреса firewall.address.name или группы firewall.addrgrp.name.

dynamic_gateway

строка

Включить использование динамического шлюза, полученного от сервера DHCP или PPP.

Выбор:

  • "enable"
  • "disable"

gateway

строка

IP-адрес шлюза для этого маршрута.

internet_service

целое число

Идентификатор приложения в базе данных интернет-сервиса. Идентификатор источника firewall.internet-service.id.

internet_service_custom

строка

Имя приложения в пользовательской базе данных интернет-сервиса. Имя источника firewall.internet-service-custom.name.

link_monitor_exempt

строка

Включить/выключить отказ от этого статического маршрута при отключении мониторинга или проверки работоспособности канала.

Выбор:

  • "enable"
  • "disable"

preferred_source

строка

Предпочтительный IP-адрес источника для этого маршрута.

priority

целое число

Административный приоритет (1 - 65535).

sdwan

строка

Включить/выключить выход через SD-WAN.

Выбор:

  • "enable"
  • "disable"

sdwan_zone

список / элементы=словарь

Выбор зоны SD-WAN.

name

строка / обязательно

Имя зоны SD-WAN. Имя зоны источника system.sdwan.zone.name.

seq_num

целое число / обязательное

Порядковый номер. см. <a href=’#notes’>Примечания</a>.

src

строка

Исходный префикс для этой маршрутизации.

status

строка

Включить/отключить эту статическую маршрутизацию.

Варианты:

  • "enable"
  • "disable"

tag

целое число

Тег маршрута.

virtual_wan_link

строка

Включить/отключить выход через виртуальную ссылку wan.

Варианты:

  • "enable"
  • "disable"

vrf

целое число

Идентификатор виртуального маршрутизации.

weight

целое число

Административный вес (0-255).

state

строка / обязательное

Указывает, нужно ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

строка

Виртуальная область, среди тех, что определены ранее. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Мы настоятельно рекомендуем использовать собственное значение в качестве seq_num вместо 0, тогда как «0» является специальным заполнительём, который позволяет бэкенду назначить последнее доступное число для объекта, но у него есть ограничения. Подробности см. в разделе «Вопросы и ответы».
  • Модуль legacy fortiosapi устарел, httpapi является предпочтительным способом выполнения playbooks
  • Модуль поддерживает режим check_mode.

Примеры

- name: Configure IPv4 static routing tables.
  fortinet.fortios.fortios_router_static:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_static:
          bfd: "enable"
          blackhole: "enable"
          comment: "Optional comments."
          device: "<your_own_value> (source system.interface.name)"
          distance: "10"
          dst: "<your_own_value>"
          dstaddr: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
          dynamic_gateway: "enable"
          gateway: "<your_own_value>"
          internet_service: "0"
          internet_service_custom: "<your_own_value> (source firewall.internet-service-custom.name)"
          link_monitor_exempt: "enable"
          preferred_source: "<your_own_value>"
          priority: "1"
          sdwan: "enable"
          sdwan_zone:
              -
                  name: "default_name_19 (source system.sdwan.zone.name)"
          seq_num: "<you_own_value>"
          src: "<your_own_value>"
          status: "enable"
          tag: "0"
          virtual_wan_link: "enable"
          vrf: "unspecified"
          weight: "0"

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

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

Ключ

Описание

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_static_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API