fortinet.fortimanager.fmgr_hotspot20_h2qposuprovider модуль — Настройка онлайн-регистрации

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
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. Варианты: `"oma-dm"` `"soap-xml-spp"` `"reserved"`
osu_nai строка	Устаревшее, пожалуйста, переименуйте на osu_nai. OSU NAI.
server_uri строка	Устаревшее, пожалуйста, переименуйте на server_uri. URI сервера.
service_description список / элементы=словарь	Устаревшее, пожалуйста, переименуйте на service_description. Описание сервиса.
lang строка	Код языка.
service_description строка	Устаревшее, пожалуйста, переименуйте на service_description. Описание сервиса.
service_id целое число	Устаревшее, пожалуйста, переименуйте на service_id. ID сервиса OSU.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.

состояние строка / обязательно	Направление для создания, обновления или удаления объекта. Выбоpы: `"present"` `"absent"`
workspace_locking_adom строка	Область ADOM для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области, параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Для создания или обновления объекта используйте параметр state present.
Для удаления объекта используйте параметр state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращается код rc отличным от нуля. Вы также можете переопределить условия для завершения ошибкой или успехом с параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure online sign up
      fortinet.fortimanager.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: present # <value in [present, absent]>
        hotspot20_h2qposuprovider:
          friendly_name:
            -
              friendly_name: <string>
              index: <integer>
              lang: <string>
          icon: <string>
          name: <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 запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

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