fortinet.fortimanager.fmgr_system_ha_peer – Узел.

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).

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

Для использования в книге задач, укажите: fortinet.fortimanager.fmgr_system_ha_peer.

Новое в версии 2.10: of fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: no ← yes	устанавливается в True только в том случае, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed list / elements=string			список кодов rc, с которыми будут переопределены условия для завершения с ошибкой
rc_succeeded list / elements=string			список кодов rc, с которыми будут переопределены условия для успешного завершения
state string / required		Варианты: present absent	директива для создания, обновления или удаления объекта
system_ha_peer dictionary			параметры верхнего уровня
	id integer	Значение по умолчанию: 0	Идентификатор.
	ip string	Значение по умолчанию: "0.0.0.0"	IP-адрес узла.
	ip6 string	Значение по умолчанию: "::"	IP-адрес (V6) узла.
	serial-number string		Серийный номер узла.
workspace_locking_adom string			adom для блокировки FortiManager, работающего в режиме рабочего пространства. Значение может быть global и другими, включая root
workspace_locking_timeout integer		Значение по умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства

Примечания

Примечание

Поддержка работы в режиме блокировки рабочего пространства в данном модуле FortiManager; параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой rc. Вы также можете переопределить условия для завершения с ошибкой или успешного завершения с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Peer.
     fmgr_system_ha_peer:
        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, ...]
        state: <value in [present, absent]>
        system_ha_peer:
           id: <value of integer>
           ip: <value of string>
           ip6: <value of string>
           serial-number: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_ha_peer_module.html