модуль fortinet.fortimanager.fmgr_hotspot20_h2qposuprovider — Настройка онлайн-регистрации
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_hotspot20_h2qposuprovider.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log логическое значение | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
hotspot20_h2qposuprovider словарь | Набор параметров верхнего уровня. |
|
friendly_name псевдонимы: friendly-name список / элементы=словарь |
Понятное имя. |
|
friendly_name псевдонимы: friendly-name строка |
Понятное имя поставщика OSU. |
|
index целое число |
Индекс понятного имени поставщика OSU. |
|
lang строка |
Код языка. |
|
icon строка |
Значок поставщика OSU. |
|
name строка / обязательный |
Идентификатор поставщика OSU. |
|
osu_method псевдонимы: osu-method список / элементы=строка |
Список методов OSU. Варианты:
|
|
osu_nai псевдонимы: osu-nai строка |
NAI OSU. |
|
server_uri псевдонимы: server-uri строка |
URI сервера. |
|
service_description псевдонимы: service-description список / элементы=словарь |
Описание службы. |
|
lang строка |
Код языка. |
|
service_description псевдонимы: service-description строка |
Описание службы. |
|
service_id псевдонимы: service-id целое число |
Идентификатор службы OSU. |
proposed_method строка | Метод, переопределяющий метод базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, переопределяющий условия ошибки. |
rc_succeeded список / элементы=целое число | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note строка | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state строка / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
workspace_locking_adom строка | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другое имя, включая root. |
workspace_locking_timeout целое число | Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure online sign up
fortinet.fortimanager.fmgr_hotspot20_h2qposuprovider:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
hotspot20_h2qposuprovider:
name: "your value" # Required variable, string
# friendly_name:
# - friendly_name: <string>
# index: <integer>
# lang: <string>
# icon: <string>
# osu_method: ["oma-dm", "soap-xml-spp", "reserved"]
# osu_nai: <string>
# server_uri: <string>
# service_description:
# - lang: <string>
# service_description: <string>
# service_id: <integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_hotspot20_h2qposuprovider_module.html
