fortinet.fortimanager.fmgr_hotspot20_h2qpadviceofcharge_aoclist модуль – Список AOC.

Примечание

Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.7.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

Добавлена в fortinet.fortimanager 2.1.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.
h2qp-advice-of-charge строка	Устарело, используйте «h2qp_advice_of_charge»
h2qp_advice_of_charge строка	Параметр (h2qp-advice-of-charge) в запрошенном URL.
hotspot20_h2qpadviceofcharge_aoclist словарь	Настройка параметров верхнего уровня.
nai_realm строка	Устарело, переименуйте в nai_realm. Имя списка областей NAI.
nai_realm_encoding строка	Устарело, переименуйте в nai_realm_encoding. Кодировка области NAI.
name строка / обязательно	Идентификатор платы за услуги.
plan_info список / элементы=словарь	Устарело, переименуйте в plan_info. Информация о плане.
currency строка	Код валюты.
info_file строка	Устарело, переименуйте в info_file. Файл информации.
lang строка	Код языка.
name строка	Название плана.
type строка	Тип платы за использование. Варианты: `"time-based"` `"volume-based"` `"time-and-volume-based"` `"unlimited"`
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	Область для блокировки в FortiManager, работающем в режиме рабочей области, значение может быть глобальным и другими, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания, пока другой пользователь освободит блокировку рабочего пространства.

По умолчанию: 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: AOC list.
      fortinet.fortimanager.fmgr_hotspot20_h2qpadviceofcharge_aoclist:
        # 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>
        h2qp_advice_of_charge: <your own value>
        state: present # <value in [present, absent]>
        hotspot20_h2qpadviceofcharge_aoclist:
          nai_realm: <string>
          nai_realm_encoding: <string>
          name: <string>
          plan_info:
            -
              currency: <string>
              info_file: <string>
              lang: <string>
              name: <string>
          type: <value in [time-based, volume-based, time-and-volume-based, ...]>

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

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

Ключ	Описание
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_h2qpadviceofcharge_aoclist_module.html