модуль fortinet.fortimanager.fmgr_fsp_vlan_interface_vrrp — настройка VRRP.

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_fsp_vlan_interface_vrrp.

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
fsp_vlan_interface_vrrp dictionary	Набор параметров верхнего уровня.
accept_mode псевдонимы: accept-mode string	Режим приёма. Варианты: `"disable"` `"enable"`
adv_interval псевдонимы: adv-interval integer	Интервал отправки объявлений.
ignore_default_route псевдонимы: ignore-default-route string	Игнорировать маршрут по умолчанию. Варианты: `"disable"` `"enable"`
preempt string	Упреждение. Варианты: `"disable"` `"enable"`
priority integer	Приоритет.
proxy_arp псевдонимы: proxy-arp list / элементы=dictionary	Прокси-ARP.
id integer	Идентификатор.
ip string	Указание IP-адресов прокси-ARP.
start_time псевдонимы: start-time integer	Время запуска.
status string	Состояние. Варианты: `"disable"` `"enable"`
version string	Версия. Варианты: `"2"` `"3"`
vrdst any	(список) Vrdst.
vrdst_priority псевдонимы: vrdst-priority integer	Приоритет vrdst.
vrgrp integer	Vrgrp.
vrid integer / обязательный	Vrid.
vrip string	Vrip.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия завершения с ошибкой.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного завершения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Указание на создание, обновление или удаление объекта. Варианты: `"present"` `"absent"`
vlan string / обязательный	Параметр (vlan) в запрашиваемом URL.
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочего пространства. Значением может быть global или другие варианты, включая 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 позволяют выполнять необходимые действия.
Обычно выполнение модуля завершается с ошибкой, если возвращается ненулевой код 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: VRRP configuration.
      fortinet.fortimanager.fmgr_fsp_vlan_interface_vrrp:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        vlan: <your own value>
        state: present # <value in [present, absent]>
        fsp_vlan_interface_vrrp:
          vrid: 0 # Required variable, integer
          # accept_mode: <value in [disable, enable]>
          # adv_interval: <integer>
          # ignore_default_route: <value in [disable, enable]>
          # preempt: <value in [disable, enable]>
          # priority: <integer>
          # start_time: <integer>
          # status: <value in [disable, enable]>
          # version: <value in [2, 3]>
          # vrdst: <list or string>
          # vrdst_priority: <integer>
          # vrgrp: <integer>
          # vrip: <string>
          # proxy_arp:
          #   - id: <integer>
          #     ip: <string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_fsp_vlan_interface_vrrp_module.html