fortinet.fortimanager.fmgr_system_ha модуль – Настройка HA.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
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, по которым будет переопределено условие успеха.
system_ha словарь	Настроенные параметры верхнего уровня.
clusterid целое число	Диапазон ID кластера
failover_mode строка	Режим резервного копирования HA. manual - Ручной резервный запуск vrrp - Использование VRRP Варианты: `"manual"` `"vrrp"`
file_quota целое число	Квота на файлы в МБ
hb_interval целое число	Интервал проверки состояния
hb_lost_threshold целое число	Порог потери проверки состояния
local_cert строка	Установить локальный сертификат HA
mode строка	Режим. standalone - Автономный. master - Мастер. slave - Ведомый. Варианты: `"standalone"` `"master"` `"slave"` `"primary"` `"secondary"`
monitored_interfaces список / элементы=словарь	Отслеживаемые интерфейсы.
interface_name строка	Имя интерфейса.
monitored_ips список / элементы=словарь	Отслеживаемые IP-адреса.
id целое число	Идентификатор.
interface строка	Имя интерфейса.
ip строка	IP-адрес.
password любой тип	(список) Пароль группы.
peer список / элементы=словарь	Узел.

END_OF_DOCUMENT_MARKER

id целое число	Идентификатор.
ip строка	IP-адрес узла.
ip6 строка	IP-адрес
serial-number строка	Устарело, пожалуйста, переименуйте на serial_number. Серийный номер узла.
status строка	Статус администрирования узла. disable - Отключить. enable - Включить. Варианты: `"disable"` `"enable"`
priority целое число	Приоритет во время работы [1
unicast строка	Использовать уникаст для сообщения VRRP. disable - Отключить. enable - Включить. Варианты: `"disable"` `"enable"`
vip строка	Виртуальный IP.
vip-interface строка	Устарело, пожалуйста, переименуйте на vip_interface. Интерфейс виртуального IP.
vrrp-adv-interval целое число	Устарело, пожалуйста, переименуйте на vrrp_adv_interval. Интервал оповещения VRRP [1 - 30 секунд]
vrrp-interface строка	Устарело, пожалуйста, переименуйте на vrrp_interface. Интерфейс VRRP и виртуального IP.
workspace_locking_adom строка	ADOM для блокировки в режиме работы в рабочей области FortiManager, значение может быть глобальным и другими, включая корень.
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 помогают выполнить эту работу.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой код 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: HA configuration.
      fortinet.fortimanager.fmgr_system_ha:
        # 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, ...]
        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 словарь	Результат запроса. Возвращается: всегда
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_system_ha_module.html