fortinet.fortimanager.fmgr_hotspot20_anqproamingconsortium – Настройка консорциума роуминга.

Примечание

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

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL
bypass_validation логическое значение			Варианты: нет ← да	устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
hotspot20_anqproamingconsortium словарь				настройка параметров верхнего уровня
	name строка			Имя консорциума роуминга.
	oi-list список / элементы=строка			без описания
		comment строка		Комментарий.
		index целое число		Индекс OI.
		oi строка		Идентификатор организации.
rc_failed список / элементы=строка				список кодов rc, при которых условия будут игнорироваться
rc_succeeded список / элементы=строка				список кодов rc, при которых условия будут игнорироваться
state строка / обязательно			Варианты: present absent	направление для создания, обновления или удаления объекта
workspace_locking_adom строка				область для блокировки FortiManager, работающего в режиме рабочей области, значение может быть global и другими, включая корневой
workspace_locking_timeout целое число			По умолчанию: 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: Configure roaming consortium.
     fmgr_hotspot20_anqproamingconsortium:
        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>
        state: <value in [present, absent]>
        hotspot20_anqproamingconsortium:
           name: <value of string>
           oi-list:
             -
                 comment: <value of string>
                 index: <value of integer>
                 oi: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрошенный URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Дескриптивное сообщение ответа 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_hotspot20_anqproamingconsortium_module.html