Модуль fortinet.fortimanager.fmgr_router_routemap — настройка карт маршрутизации.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_router_routemap.
Добавлено в fortinet.fortimanager 2.1.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать с учетом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Возможные значения:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Возможные значения:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Возможные значения:
|
rc_failed list / elements=integer | Список кодов rc, которыми будут переопределены условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, которыми будут переопределены условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
router_routemap dictionary | Набор параметров верхнего уровня. |
|
comments string |
Необязательные комментарии. |
|
name string / обязательный |
Имя. |
|
rule list / elements=dictionary |
Правило. |
|
action string |
Действие. Возможные значения:
|
|
id integer |
Идентификатор правила. |
|
match_as_path псевдонимы: match-as-path string |
Сопоставление со списком путей BGP AS. |
|
match_community псевдонимы: match-community string |
Сопоставление со списком сообществ BGP. |
|
match_community_exact псевдонимы: match-community-exact string |
Включить/отключить точное сопоставление сообществ. Возможные значения:
|
|
match_extcommunity псевдонимы: match-extcommunity string |
Сопоставление со списком расширенных сообществ BGP. |
|
match_extcommunity_exact псевдонимы: match-extcommunity-exact string |
Включить/отключить точное сопоставление расширенных сообществ. Возможные значения:
|
|
match_flags псевдонимы: match-flags integer |
Флаги сопоставления. |
|
match_interface псевдонимы: match-interface string |
Сопоставление с конфигурацией интерфейса. |
|
match_ip6_address псевдонимы: match-ip6-address string |
Сопоставление с адресом IPv6, разрешённым access-list6 или prefix-list6. |
|
match_ip6_nexthop псевдонимы: match-ip6-nexthop string |
Сопоставление с адресом IPv6 следующего перехода, указанным в access-list6 или prefix-list6. |
|
match_ip_address псевдонимы: match-ip-address string |
Сопоставление с IP-адресом, разрешённым access-list или prefix-list. |
|
match_ip_nexthop псевдонимы: match-ip-nexthop string |
Сопоставление с IP-адресом следующего перехода, указанным в access-list или prefix-list. |
|
match_metric псевдонимы: match-metric string |
Сопоставление метрики для перераспределяемых маршрутов. |
|
match_origin псевдонимы: match-origin string |
Сопоставление с кодом источника BGP. Возможные значения:
|
|
match_route_type псевдонимы: match-route-type string |
Сопоставление с типом маршрута. Возможные значения:
|
|
match_suppress псевдонимы: match-suppress string |
Включить/отключить сопоставление с подавленным исходным соседом. Возможные значения:
|
|
match_tag псевдонимы: match-tag string |
Сопоставление с тегом. |
|
match_vrf псевдонимы: match-vrf integer |
Сопоставление с идентификатором VRF. |
|
set_aggregator_as псевдонимы: set-aggregator-as integer |
AS агрегатора BGP. |
|
set_aggregator_ip псевдонимы: set-aggregator-ip string |
IP-адрес агрегатора BGP. |
|
set_aspath псевдонимы: set-aspath any |
(список) Добавить префикс к атрибуту пути BGP AS. |
|
set_aspath_action псевдонимы: set-aspath-action string |
Указать предпочтительное действие для set-aspath. Возможные значения:
|
|
set_atomic_aggregate псевдонимы: set-atomic-aggregate string |
Включить/отключить атрибут атомарной агрегации BGP. Возможные значения:
|
|
set_community псевдонимы: set-community any |
(список) Атрибут сообщества BGP. |
|
set_community_additive псевдонимы: set-community-additive string |
Включить/отключить добавление set-community к существующему сообществу. Возможные значения:
|
|
set_community_delete псевдонимы: set-community-delete string |
Удалить сообщества, соответствующие списку сообществ. |
|
set_dampening_max_suppress псевдонимы: set-dampening-max-suppress integer |
Максимальная длительность подавления маршрута |
|
set_dampening_reachability_half_life псевдонимы: set-dampening-reachability-half-life integer |
Время полураспада штрафа при доступности маршрута |
|
set_dampening_reuse псевдонимы: set-dampening-reuse integer |
Пороговое значение для повторного использования маршрута |
|
set_dampening_suppress псевдонимы: set-dampening-suppress integer |
Пороговое значение для начала подавления маршрута |
|
set_dampening_unreachability_half_life псевдонимы: set-dampening-unreachability-half-life integer |
Время полураспада штрафа при недоступности маршрута |
|
set_extcommunity_rt псевдонимы: set-extcommunity-rt any |
(список) Расширенное сообщество Route Target. |
|
set_extcommunity_soo псевдонимы: set-extcommunity-soo any |
(список) Расширенное сообщество Site-of-Origin. |
|
set_flags псевдонимы: set-flags integer |
Установить флаги. |
|
set_ip6_nexthop псевдонимы: set-ip6-nexthop string |
Глобальный адрес IPv6 следующего перехода. |
|
set_ip6_nexthop_local псевдонимы: set-ip6-nexthop-local string |
Локальный адрес IPv6 следующего перехода. |
|
set_ip_nexthop псевдонимы: set-ip-nexthop string |
IP-адрес следующего перехода. |
|
set_ip_prefsrc псевдонимы: set-ip-prefsrc string |
IP-адрес предпочтительного источника. |
|
set_local_preference псевдонимы: set-local-preference string |
Атрибут пути локального предпочтения BGP. |
|
set_metric псевдонимы: set-metric string |
Значение метрики. |
|
set_metric_type aliases: set-metric-type string |
Тип метрики. Варианты:
|
|
set_origin aliases: set-origin string |
Код источника BGP. Варианты:
|
|
set_originator_id aliases: set-originator-id string |
Атрибут идентификатора инициатора BGP. |
|
set_priority aliases: set-priority integer |
Приоритет для таблицы маршрутизации. |
|
set_route_tag aliases: set-route-tag string |
Тег маршрута для таблицы маршрутизации. |
|
set_tag aliases: set-tag string |
Значение тега. |
|
set_vpnv4_nexthop aliases: set-vpnv4-nexthop string |
IP-адрес следующего узла VPNv4. |
|
set_vpnv6_nexthop aliases: set-vpnv6-nexthop string |
Глобальный IPv6-адрес следующего узла VPNv6. |
|
set_vpnv6_nexthop_local aliases: set-vpnv6-nexthop-local string |
Локальный IPv6-адрес канала следующего узла VPNv6. |
|
set_weight aliases: set-weight string |
Вес BGP для таблицы маршрутизации. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure route maps.
fortinet.fortimanager.fmgr_router_routemap:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
router_routemap:
name: "your value" # Required variable, string
# comments: <string>
# rule:
# - action: <value in [permit, deny]>
# id: <integer>
# match_as_path: <string>
# match_community: <string>
# match_community_exact: <value in [disable, enable]>
# match_flags: <integer>
# match_interface: <string>
# match_ip_address: <string>
# match_ip_nexthop: <string>
# match_ip6_address: <string>
# match_ip6_nexthop: <string>
# match_metric: <string>
# match_origin: <value in [none, egp, igp, ...]>
# match_route_type: <value in [1, 2, none, ...]>
# match_tag: <string>
# match_vrf: <integer>
# set_aggregator_as: <integer>
# set_aggregator_ip: <string>
# set_aspath: <list or string>
# set_aspath_action: <value in [prepend, replace]>
# set_atomic_aggregate: <value in [disable, enable]>
# set_community: <list or string>
# set_community_additive: <value in [disable, enable]>
# set_community_delete: <string>
# set_dampening_max_suppress: <integer>
# set_dampening_reachability_half_life: <integer>
# set_dampening_reuse: <integer>
# set_dampening_suppress: <integer>
# set_dampening_unreachability_half_life: <integer>
# set_extcommunity_rt: <list or string>
# set_extcommunity_soo: <list or string>
# set_flags: <integer>
# set_ip_nexthop: <string>
# set_ip6_nexthop: <string>
# set_ip6_nexthop_local: <string>
# set_local_preference: <string>
# set_metric: <string>
# set_metric_type: <value in [1, 2, none, ...]>
# set_origin: <value in [none, egp, igp, ...]>
# set_originator_id: <string>
# set_priority: <integer>
# set_route_tag: <string>
# set_tag: <string>
# set_weight: <string>
# match_extcommunity: <string>
# match_extcommunity_exact: <value in [disable, enable]>
# set_ip_prefsrc: <string>
# set_vpnv4_nexthop: <string>
# set_vpnv6_nexthop: <string>
# set_vpnv6_nexthop_local: <string>
# match_suppress: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Текстовое описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложных условиях |
Ссылки на коллекцию
© 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_router_routemap_module.html