Spec-Zone.ru › Ansible

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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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

строка

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

adom

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

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

bypass_validation

логическое

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

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

логическое

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

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

строка

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

fsp_vlan_interface_vrrp

словарь

Установленные параметры верхнего уровня.

accept_mode

строка

Устаревшее, пожалуйста, переименуйте на accept_mode. Режим приема.

Варианты:

  • "disable"
  • "enable"

adv_interval

целое число

Устаревшее, пожалуйста, переименуйте на adv_interval. Интервал ADV.

ignore_default_route

строка

Устаревшее, пожалуйста, переименуйте на ignore_default_route. Игнорировать маршрут по умолчанию.

Варианты:

  • "disable"
  • "enable"

preempt

строка

Преемственность.

Варианты:

  • "disable"
  • "enable"

priority

целое число

Приоритет.

proxy_arp

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

Устаревшее, пожалуйста, переименуйте на proxy_arp. Прокси arp.

id

целое число

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

ip

строка

Устанавливаются IP-адреса прокси ARP.

start_time

целое число

Устаревшее, пожалуйста, переименуйте на start_time. Время запуска.

status

строка

Статус.

Варианты:

  • "disable"
  • "enable"

version

строка

Версия.

Варианты:

  • "2"
  • "3"

vrdst

любой

(список) Vrdst.

vrdst_priority

целое число

Устаревшее, пожалуйста, переименуйте на vrdst_priority. Приоритет Vrdst.

vrgrp

целое число

Vrgrp.

vrid

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

Vrid.

vrip

строка

Vrip.

proposed_method

строка

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

Варианты:

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

rc_failed

список / элементы=целое число

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

rc_succeeded

список / элементы=целое число

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

state

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

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

Варианты:

  • "present"
  • "absent"

vlan

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

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

workspace_locking_adom

строка

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

workspace_locking_timeout

целое число

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

По умолчанию: 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. Вы также можете переопределить условия сбоя или успеха с помощью параметров 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: VRRP configuration.
      fortinet.fortimanager.fmgr_fsp_vlan_interface_vrrp:
        # 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>
        vlan: <your own value>
        state: present # <value in [present, absent]>
        fsp_vlan_interface_vrrp:
          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>
          vrid: <integer>
          vrip: <string>
          proxy_arp:
            -
              id: <integer>
              ip: <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_fsp_vlan_interface_vrrp_module.html

Spec-Zone.ru

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