fortinet.fortimanager.fmgr_hotspot20_h2qposuprovider – Configure online sign up (OSU) provider list. — Ansible 2.11

Примечание

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

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

Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_hotspot20_h2qposuprovider.

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

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно				параметр (adom) в запрошенном URL-адресе
bypass_validation логическое значение			Варианты: нет ← да	устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров
hotspot20_h2qposuprovider словарь				устанавливаемые параметры верхнего уровня
	friendly-name список / элементы=строка			без описания
		friendly-name строка		Наименование поставщика OSU.
		index целое число		Индекс имени поставщика OSU.
		lang строка		Код языка.
	icon строка			Иконка поставщика OSU.
	name строка			Идентификатор поставщика OSU.
	osu-method список / элементы=строка		Варианты: oma-dm soap-xml-spp reserved	без описания
	osu-nai строка			OSU NAI.
	server-uri строка			Адрес сервера URI.
	service-description список / элементы=строка			без описания
		lang строка		Код языка.
		service-description строка		Описание сервиса.
		service-id целое число		Идентификатор сервиса OSU.
rc_failed список / элементы=строка				список кодов rc, при которых условия будут нарушены
rc_succeeded список / элементы=строка				список кодов rc, при которых условия будут выполнены
state строка / обязательно			Варианты: present absent	направление создания, обновления или удаления объекта
workspace_locking_adom строка				adom для блокировки при работе FortiManager в режиме рабочего пространства, значение может быть глобальным и другими, включая корневое
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 online sign up (OSU) provider list.
     fmgr_hotspot20_h2qposuprovider:
        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_h2qposuprovider:
           friendly-name:
             -
                 friendly-name: <value of string>
                 index: <value of integer>
                 lang: <value of string>
           icon: <value of string>
           name: <value of string>
           osu-method:
             - oma-dm
             - soap-xml-spp
             - reserved
           osu-nai: <value of string>
           server-uri: <value of string>
           service-description:
             -
                 lang: <value of string>
                 service-description: <value of string>
                 service-id: <value of integer>

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

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

Ключ	Возвращаемое значение	Описание
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_h2qposuprovider_module.html