fortinet.fortimanager.fmgr_router_routemap_rule модуль — Правило.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в книге задач, укажите: fortinet.fortimanager.fmgr_router_routemap_rule.

Новое в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без валидации параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия для ошибки.
rc_succeeded список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия для успеха.
route-map строка	Устарело, используйте “route_map”
route_map строка	Параметр (route-map) в запрошенном URL.
router_routemap_rule словарь	Настроены параметры верхнего уровня.
action строка	Действие. Варианты: `"permit"` `"deny"`
id целое число / обязательно	ID правила.
match_as_path строка	Сопоставление списка AS пути BGP.
match_community строка	Сопоставление списка сообществ BGP.
match_community_exact строка	Включить/отключить точное сопоставление сообществ. Варианты: `"disable"` `"enable"`
match_extcommunity строка	Сопоставление списка расширенных сообществ BGP.
match_extcommunity_exact строка	Включить/отключить точное сопоставление расширенных сообществ. Варианты: `"disable"` `"enable"`
match_flags целое число	Сопоставление флагов.
match_interface строка	Сопоставление конфигурации интерфейса.
match_ip_address строка	Сопоставление IP-адреса, разрешенного списком доступа или списком префиксов.
match_ip_nexthop строка	Сопоставление IP-адреса следующей метки, переданного списком доступа или списком префиксов.

END_OF_DOCUMENT_MARKER

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. Сопоставление идентификатора VRF.
set-aggregator-as integer	Устаревшее, пожалуйста, переименуйте на set_aggregator_as. AS агрегатора BGP.

END_OF_DOCUMENT_MARKER

set-extcommunity-soo any	(list) Устаревшее, пожалуйста, переименуйте на set_extcommunity_soo. Расширенное сообщество Site-of-Origin.
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 локальной предпочтения.

Примечания

Примечание

Начиная с версии 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. Вы также можете переопределить условия для завершения ошибкой или успешно с параметрами 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: Rule.
      fortinet.fortimanager.fmgr_router_routemap_rule:
        # 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>
        route_map: <your own value>
        state: present # <value in [present, absent]>
        router_routemap_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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный запрашиваемый URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_rule_module.html