Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_router_routemap – Настройка маршрутных карт.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Новое в fortinet.fortimanager 2.1.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настроить устройство FortiManager.
  • Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / required

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров.

Варианты:

  • false ← (default)
  • true

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (default)
  • true

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, с помощью которых будут переопределены условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, с помощью которых будут переопределены условия успеха.

router_routemap

dictionary

Набор параметров верхнего уровня.

comments

string

Необязательные комментарии.

name

string / required

Имя.

rule

list / elements=dictionary

Правило.

action

string

Действие.

Варианты:

  • "permit"
  • "deny"

id

integer

Идентификатор правила.

match-as-path

string

Устарело, переименуйте в match_as_path. Сопоставление списка AS-путей BGP.

match-community

string

Устарело, переименуйте в match_community. Сопоставление списка сообществ BGP.

match-community-exact

string

Устарело, переименуйте в match_community_exact. Включить/отключить точное сопоставление сообществ.

Варианты:

  • "disable"
  • "enable"

match-extcommunity

string

Устарело, переименуйте в match_extcommunity. Сопоставление списка расширенных сообществ BGP.

match-extcommunity-exact

string

Устарело, переименуйте в match_extcommunity_exact. Включить/отключить точное сопоставление расширенных сообществ.

Варианты:

  • "disable"
  • "enable"

match-flags

integer

Устарело, переименуйте в match_flags. Сопоставление флагов.

match-interface

string

Устарело, переименуйте в match_interface. Сопоставление конфигурации интерфейса.

match-ip-address

string

Устарело, переименуйте в match_ip_address. Сопоставление IP-адреса, разрешённого списком доступа или списком префиксов.

match-ip-nexthop

string

Устарело, переименуйте в match_ip_nexthop. Сопоставление IP-адреса следующего перехода, переданного списком доступа или списком префиксов.

match-ip6-address

string

Устарело, переименуйте в match_ip6_address. Сопоставление IPv6-адреса, разрешённого списком доступа6 или списком префиксов6.

match-ip6-nexthop

string

Устарело, переименуйте в match_ip6_nexthop. Сопоставление IPv6-адреса следующего перехода, переданного списком доступа6 или списком префиксов6.

match-metric

string

Устарело, переименуйте в match_metric. Сопоставление метрики для маршрутов перераспределения.

match-origin

string

Устарело, переименуйте в match_origin. Сопоставление кода происхождения BGP.

Варианты:

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

match-route-type

string

Устарело, переименуйте в match_route_type. Тип маршрута.

Варианты:

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

match-tag

string

Устарело, переименуйте в match_tag. Тег соответствия.

match-vrf

integer

Устарело, переименуйте в match_vrf. Соответствие ID VRF.

set-aggregator-as

integer

Устарело, переименуйте в set_aggregator_as. AS агрегатора BGP.

set-aggregator-ip

string

Устарело, переименуйте в set_aggregator_ip. IP-адрес агрегатора BGP.

set-aspath

any

(список) Устарело, переименуйте в set_aspath. Добавить атрибут пути AS BGP.

set-aspath-action

string

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

Варианты:

  • "prepend"
  • "replace"

set-atomic-aggregate

string

Устарело, переименуйте в set_atomic_aggregate. Включить/выключить атрибут атомарной агрегации BGP.

Варианты:

  • "disable"
  • "enable"

set-community

any

(список) Устарело, переименуйте в set_community. Атрибут сообщества BGP.

set-community-additive

string

Устарело, переименуйте в set_community_additive. Включить/выключить добавление set-community к существующему сообществу.

Варианты:

  • "disable"
  • "enable"

set-community-delete

string

Устарело, переименуйте в set_community_delete. Удалить сообщества, соответствующие списку сообществ.

set-dampening-max-suppress

integer

Устарело, переименуйте в set_dampening_max_suppress. Максимальная продолжительность подавления маршрута

set-dampening-reachability-half-life

integer

Устарело, переименуйте в set_dampening_reachability_half_life. Время полураспада доступности для штрафа

set-dampening-reuse

integer

Устарело, переименуйте в set_dampening_reuse. Значение для начала повторного использования маршрута

set-dampening-suppress

integer

Устарело, переименуйте в set_dampening_suppress. Значение для начала подавления маршрута

set-dampening-unreachability-half-life

integer

Устарело, переименуйте в set_dampening_unreachability_half_life. Время полураспада недоступности для штрафа

set-extcommunity-rt

any

(список) Устарело, переименуйте в set_extcommunity_rt. Расширенное сообщество целевого маршрута.

set-extcommunity-soo

any

(список) Устарело, переименуйте в set_extcommunity_soo. Расширенное сообщество места происхождения.

set-flags

integer

Устарело, переименуйте в set_flags. Установить флаги.

set-ip-nexthop

string

Устарело, переименуйте в set_ip_nexthop. IP-адрес следующего перехода.

set-ip-prefsrc

string

Устарело, переименуйте в set_ip_prefsrc. IP-адрес предпочтительного источника.

set-ip6-nexthop

string

Устарело, переименуйте в set_ip6_nexthop. Глобальный IPv6-адрес следующего перехода.

set-ip6-nexthop-local

string

Устарело, переименуйте в set_ip6_nexthop_local. Локальный IPv6-адрес следующего перехода.

set-local-preference

string

Устарело, переименуйте в set_local_preference. Атрибут пути локальных предпочтений BGP.

set-metric

string

Устарело, переименуйте в set_metric. Значение метрики.

set-metric-type

string

Устарело, переименуйте в set_metric_type. Тип метрики.

Варианты:

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

set-origin

string

Устарело, переименуйте в set_origin. Код источника BGP.

Варианты:

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

set-originator-id

string

Устарело, переименуйте в set_originator_id. Атрибут идентификатора источника BGP.

set-priority

integer

Устарело, переименуйте в set_priority. Приоритет для таблицы маршрутизации.

set-route-tag

string

Устарело, переименуйте в set_route_tag. Тег маршрута для таблицы маршрутизации.

set-tag

string

Устарело, переименуйте в set_tag. Значение тега.

set-vpnv4-nexthop

string

Устарело, переименуйте в set_vpnv4_nexthop. IP-адрес следующего перехода VPNv4.

set-vpnv6-nexthop

string

Устарело, переименуйте в set_vpnv6_nexthop. Глобальный IPv6-адрес следующего перехода VPNv6.

set-vpnv6-nexthop-local

string

Устарело, переименуйте в set_vpnv6_nexthop_local. Локальный IPv6-адрес следующего перехода VPNv6.

set-weight

string

Устарело, переименуйте в set_weight. Вес BGP для таблицы маршрутизации.

state

string / required

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

string

ADOM для блокировки для FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0, все входные аргументы имеют имена, использующие соглашение об именовании со знаками подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как «var-name», на «var_name». Старые имена аргументов все еще доступны, но вы будете получать предупреждения об устаревании. Вы можете игнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
  • В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение одного модуля может завершиться неудачей, если возвращается ненулевой код возврата. Вы также можете переопределить условия неудачи или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure route maps.
      fortinet.fortimanager.fmgr_router_routemap:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        router_routemap:
          comments: <string>
          name: <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>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL-адрес запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус API-запроса.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией FortiManager.

Возвращается: сложный

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

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

  • Система отслеживания ошибок
  • Домашняя страница
  • Репозиторий (исходный код)

© 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/fortimanager/fmgr_router_routemap_module.html

Spec-Zone.ru

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