Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_system_ha — конфигурация HA.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр

Комментарии

access_token

string

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

bypass_validation

boolean

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

Варианты:

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

enable_log

boolean

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

Варианты:

  • false ← (по умолчанию)
  • 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, переопределяющий условия успешного выполнения.

system_ha

dictionary

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

clusterid

integer

Диапазон идентификаторов кластера

failover_mode

псевдонимы: failover-mode

string

Режим переключения при отказе HA.

manual — переключение вручную

vrrp — использовать VRRP

Варианты:

  • "manual"
  • "vrrp"

file_quota

псевдонимы: file-quota

integer

Квота на файлы в МБ

hb_interval

псевдонимы: hb-interval

integer

Интервал передачи heartbeat

hb_lost_threshold

псевдонимы: hb-lost-threshold

integer

Порог потери heartbeat

local_cert

псевдонимы: local-cert

string

Задать локальный сертификат HA.

mode

string

Режим.

standalone — автономный режим.

master — ведущий узел.

slave — ведомый узел.

Варианты:

  • "standalone"
  • "master"
  • "slave"
  • "primary"
  • "secondary"

monitored_interfaces

псевдонимы: monitored-interfaces

list / elements=dictionary

Отслеживаемые интерфейсы.

interface_name

псевдонимы: interface-name

string

Имя интерфейса.

monitored_ips

псевдонимы: monitored-ips

list / elements=dictionary

Отслеживаемые IP-адреса.

id

integer

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

interface

string

Имя интерфейса.

ip

string

IP-адрес.

password

any

(список) Пароль группы.

peer

list / elements=dictionary

Узел-партнёр.

id

integer

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

ip

string

IP-адрес узла-партнёра.

ip6

string

IP-адрес

serial_number

псевдонимы: serial-number

string

Серийный номер узла-партнёра.

status

string

Административный статус узла-партнёра.

disable — отключить.

enable — включить.

Варианты:

  • "disable"
  • "enable"

priority

integer

Приоритет во время работы [1

unicast

string

Использовать unicast для сообщений VRRP.

disable — отключить.

enable — включить.

Варианты:

  • "disable"
  • "enable"

vip

string

Виртуальный IP-адрес.

vip_interface

псевдонимы: vip-interface

string

Интерфейс VIP.

vrrp_adv_interval

псевдонимы: vrrp-adv-interval

integer

Интервал объявлений VRRP [1–30 секунд]

vrrp_interface

псевдонимы: vrrp-interface

string

Интерфейс VRRP и VIP.

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global или другие ADOM, включая 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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: HA configuration.
      fortinet.fortimanager.fmgr_system_ha:
        # workspace_locking_adom: <global or your adom name>
        system_ha:
          # clusterid: <integer>
          # file_quota: <integer>
          # hb_interval: <integer>
          # hb_lost_threshold: <integer>
          # mode: <value in [standalone, master, slave, ...]>
          # password: <list or string>
          # peer:
          #   - id: <integer>
          #     ip: <string>
          #     ip6: <string>
          #     serial_number: <string>
          #     status: <value in [disable, enable]>
          # local_cert: <string>
          # failover_mode: <value in [manual, vrrp]>
          # monitored_interfaces:
          #   - interface_name: <string>
          # monitored_ips:
          #   - id: <integer>
          #     interface: <string>
          #     ip: <string>
          # priority: <integer>
          # unicast: <value in [disable, enable]>
          # vip: <string>
          # vrrp_adv_interval: <integer>
          # vrrp_interface: <string>
          # vip_interface: <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

Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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_system_ha_module.html

Spec-Zone.ru

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