Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

Обзор

  • Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять параметры маршрутизатора и категорию route_map. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с 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_route_map

словарь

Настройка маршрутных карт.

comments

строка

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

name

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

Имя.

rule

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

Правило.

action

строка

Действие.

Варианты:

  • "permit"
  • "deny"

id

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

Идентификатор правила. см. <a href=’#notes’>Примечания</a>.

match_as_path

строка

Сопоставление списка AS-путей BGP. Имя списка aspath маршрутизатора источника.

match_community

строка

Сопоставление списка сообществ BGP. Имя списка сообществ маршрутизатора источника.

match_community_exact

строка

Включить/выключить точное сопоставление сообществ.

Варианты:

  • "enable"
  • "disable"

match_extcommunity

строка

Сопоставление списка расширенных сообществ BGP. Имя списка расширенных сообществ маршрутизатора источника.

match_extcommunity_exact

строка

Включить/выключить точное сопоставление расширенных сообществ.

Варианты:

  • "enable"
  • "disable"

match_flags

целое число

Значение флага BGP для сопоставления (0 - 65535)

match_interface

строка

Сопоставление конфигурации интерфейса. Имя интерфейса системы источника.

match_ip6_address

строка

Сопоставление IPv6-адреса, разрешенного списком доступа access-list6 или префиксным списком prefix-list6. Имя списка доступа access-list6 или префиксного списка prefix-list6 маршрутизатора источника.

match_ip6_nexthop

строка

Сопоставление следующего IPv6-адреса перехода, переданного списком доступа access-list6 или префиксным списком prefix-list6. Имя списка доступа access-list6 или префиксного списка prefix-list6 маршрутизатора источника.

match_ip_address

строка

Сопоставление IP-адреса, разрешенного списком доступа access-list или префиксным списком prefix-list. Имя списка доступа access-list или префиксного списка prefix-list маршрутизатора источника.

match_ip_nexthop

строка

Сопоставление следующего IP-адреса перехода, переданного списком доступа access-list или префиксным списком prefix-list. Имя списка доступа access-list или префиксного списка prefix-list маршрутизатора источника.

match_metric

целое число

Сопоставление метрики для перераспределения маршрутов.
END_OF_DOCUMENT_MARKER

match_origin

string

Сопоставление кода источника BGP.

Варианты:

  • "none"
  • "egp"
  • "igp"
  • "incomplete"

match_route_type

string

Сопоставление типа маршрута.

Варианты:

  • "external-type1"
  • "external-type2"
  • "none"
  • "1"
  • "2"

match_tag

integer

Сопоставление тега.

match_vrf

integer

Сопоставление ID VRF.

set_aggregator_as

integer

BGP агрегатор AS.

set_aggregator_ip

string

BGP агрегатор IP.

set_aspath

list / elements=dictionary

Добавление атрибута пути AS BGP.

as

string / required

Номер AS (0 - 4294967295). Используйте кавычки для повторяющихся чисел, например, “1 1 2”.

set_aspath_action

string

Укажите предпочтительное действие set-aspath.

Варианты:

  • "prepend"
  • "replace"

set_atomic_aggregate

string

Включить/отключить атрибут атомарной агрегации BGP.

Варианты:

  • "enable"
  • "disable"

set_community

list / elements=dictionary

Атрибут сообщества BGP.

community

string / required

Атрибут: AA|AA:NN|internet|local-AS|no-advertise|no-export.

set_community_additive

string

Включить/отключить добавление set-community к существующему сообществу.

Варианты:

  • "enable"
  • "disable"

set_community_delete

string

Удалить сообщества, соответствующие списку сообществ. Source router.community-list.name.

set_dampening_max_suppress

integer

Максимальная продолжительность подавления маршрута (1 - 255 мин, 0 = не установлено).

set_dampening_reachability_half_life

integer

Время полураспада доступности для штрафа (1 - 45 мин, 0 = не установлено).

set_dampening_reuse

integer

Значение для начала повторного использования маршрута (1 - 20000, 0 = не установлено).

set_dampening_suppress

integer

Значение для начала подавления маршрута (1 - 20000, 0 = не установлено).

set_dampening_unreachability_half_life

integer

Время полураспада недоступности для штрафа (1 - 45 мин, 0 = не установлено).

set_extcommunity_rt

list / elements=dictionary

Расширенное сообщество целевого маршрута.

community

string / required

AA:NN.

set_extcommunity_soo

list / elements=dictionary

Расширенное сообщество места происхождения.

community

string / required

Сообщество (формат = AA:NN).

set_flags

integer

Значение флагов BGP (0 - 65535)

set_ip6_nexthop

string

Глобальный IPv6-адрес следующего перехода.

set_ip6_nexthop_local

string

Локальный IPv6-адрес следующего перехода.

set_ip_nexthop

string

IP-адрес следующего перехода.

set_ip_prefsrc

string

IP-адрес предпочтительного источника.

set_local_preference

integer

Атрибут пути локальных предпочтений BGP.

set_metric

integer

Значение метрики.

set_metric_type

string

Тип метрики.

Варианты:

  • "external-type1"
  • "external-type2"
  • "none"
  • "1"
  • "2"

set_origin

string

Код происхождения BGP.

Варианты:

  • "none"
  • "egp"
  • "igp"
  • "incomplete"

set_originator_id

string

Атрибут идентификатора инициатора BGP.

set_priority

integer

Приоритет для таблицы маршрутизации.

set_route_tag

integer

Тег маршрута для таблицы маршрутизации.

set_tag

integer

Значение тега.

set_vpnv4_nexthop

string

IP-адрес следующего перехода VPNv4.

set_vpnv6_nexthop

string

Глобальный IPv6-адрес следующего перехода VPNv6.

set_vpnv6_nexthop_local

string

Локальный IPv6-адрес следующего перехода VPNv6.

set_weight

integer

Вес BGP для таблицы маршрутизации.

state

string / required

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

Варианты:

  • "present"
  • "absent"

vdom

string

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

Значение по умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi был заменен, httpapi является предпочтительным способом запуска playbook'ов
  • Модуль поддерживает check_mode.

Примеры

- name: Configure route maps.
  fortinet.fortios.fortios_router_route_map:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      router_route_map:
          comments: "<your_own_value>"
          name: "default_name_4"
          rule:
              -
                  action: "permit"
                  id: "7"
                  match_as_path: "<your_own_value> (source router.aspath-list.name)"
                  match_community: "<your_own_value> (source router.community-list.name)"
                  match_community_exact: "enable"
                  match_extcommunity: "<your_own_value> (source router.extcommunity-list.name)"
                  match_extcommunity_exact: "enable"
                  match_flags: "32767"
                  match_interface: "<your_own_value> (source system.interface.name)"
                  match_ip_address: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
                  match_ip_nexthop: "<your_own_value> (source router.access-list.name router.prefix-list.name)"
                  match_ip6_address: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
                  match_ip6_nexthop: "<your_own_value> (source router.access-list6.name router.prefix-list6.name)"
                  match_metric: ""
                  match_origin: "none"
                  match_route_type: "external-type1"
                  match_tag: ""
                  match_vrf: ""
                  set_aggregator_as: "0"
                  set_aggregator_ip: "<your_own_value>"
                  set_aspath:
                      -
                          as: "<your_own_value>"
                  set_aspath_action: "prepend"
                  set_atomic_aggregate: "enable"
                  set_community:
                      -
                          community: "<your_own_value>"
                  set_community_additive: "enable"
                  set_community_delete: "<your_own_value> (source router.community-list.name)"
                  set_dampening_max_suppress: "0"
                  set_dampening_reachability_half_life: "0"
                  set_dampening_reuse: "0"
                  set_dampening_suppress: "0"
                  set_dampening_unreachability_half_life: "0"
                  set_extcommunity_rt:
                      -
                          community: "<your_own_value>"
                  set_extcommunity_soo:
                      -
                          community: "<your_own_value>"
                  set_flags: "32767"
                  set_ip_nexthop: "<your_own_value>"
                  set_ip_prefsrc: "<your_own_value>"
                  set_ip6_nexthop: "<your_own_value>"
                  set_ip6_nexthop_local: "<your_own_value>"
                  set_local_preference: ""
                  set_metric: ""
                  set_metric_type: "external-type1"
                  set_origin: "none"
                  set_originator_id: "<your_own_value>"
                  set_priority: ""
                  set_route_tag: ""
                  set_tag: ""
                  set_vpnv4_nexthop: "<your_own_value>"
                  set_vpnv6_nexthop: "<your_own_value>"
                  set_vpnv6_nexthop_local: "<your_own_value>"
                  set_weight: ""

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

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

Ключ

Описание

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

Spec-Zone.ru

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