fortinet.fortimanager.fmgr_system_ha_peer – Ведомый.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 1.0.5).

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

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

Добавлено в версии 2.10: модуля fortinet.fortimanager

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

Обзор

Этот модуль может настроить устройство FortiManager, позволяя пользователю [ добавить получить установить обновить ] следующие API.
/cli/global/system/ha/peer
Примеры включают все параметры и значения, которые необходимо скорректировать, перед использованием.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Верификация параметров выполняется нестрого
method string / обязательно	Варианты: add get set update	Метод запроса
params list / элементы=string		Параметры для каждого метода Полный список параметров см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params dictionary		Параметры для каждого URL-адреса API-запроса Полный список параметров URL также см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom string		имя ADOM для блокировки в случае работы FortiManager в режиме рабочей области может быть глобальным или любым другим пользовательским именем ADOM
workspace_locking_timeout integer	По умолчанию: 300	максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем

Примечания

Примечание

Существует только три параметра верхнего уровня, где «method» всегда обязателен, а остальные два «params» и «url_params» могут быть необязательными.
Из-за сложности схемы API fortimanager проверка выполняется вне процедуры проверки параметров Ansible.
Синтаксис OPTIONS не соответствует стандартному спецификации аргументов Ansible, но в соответствии со структурой схемы API fortimanager, нам необходимо тривиальное преобразование, когда мы заполняем книгу задач ansible.

Примеры

- 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: REQUESTING /CLI/SYSTEM/HA/PEER
     fmgr_system_ha_peer:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add, set, update]>
        params:
           -
              data:
                -
                    id: <value of integer>
                    ip: <value of string>
                    ip6: <value of string>
                    serial-number: <value of string>
                    status: <value in [disable, enable]>

   - name: REQUESTING /CLI/SYSTEM/HA/PEER
     fmgr_system_ha_peer:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        params:
           -
              fields:
                -
                   - <value in [id, ip, ip6, ...]>
              filter:
                - <value of string>
              loadsub: <value of integer>
              option: <value in [count, syntax]>

Значения возврата

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

Ключ	Возвращаемое значение	Описание
data dictionary	всегда	Полезная нагрузка, возвращаемая в запросе
status dictionary	всегда	Статус запроса API
url string	всегда	Полный запрашиваемый URL Пример: /sys/login/user

Авторы

Frank Shen (@fshen01)
Link Zheng (@zhengl)

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