модуль fortinet.fortimanager.fmgr_hotspot20_h2qpadviceofcharge_aoclist – список AOC.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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 string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager: модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
h2qp-advice-of-charge string | Устаревший параметр, используйте «h2qp_advice_of_charge» |
h2qp_advice_of_charge string | Параметр (h2qp-advice-of-charge) в запрошенном URL. |
hotspot20_h2qpadviceofcharge_aoclist dictionary | Набор параметров верхнего уровня. |
|
nai_realm псевдонимы: nai-realm string |
Имя списка областей NAI. |
|
nai_realm_encoding псевдонимы: nai-realm-encoding string |
Кодировка области NAI. |
|
name string / обязательный |
Идентификатор тарификации. |
|
plan_info псевдонимы: plan-info list / элементы=dictionary |
Информация о тарифном плане. |
|
currency string |
Код валюты. |
|
info_file псевдонимы: info-file string |
Файл с информацией. |
|
lang string |
Код языка. |
|
name string |
Название тарифного плана. |
|
type string |
Тип тарификации за использование. Варианты:
|
proposed_method string | Метод, переопределяющий метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия возникновения ошибки. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочего пространства. Значением может быть global или другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочего пространства другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: AOC list.
fortinet.fortimanager.fmgr_hotspot20_h2qpadviceofcharge_aoclist:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
h2qp_advice_of_charge: <your own value>
state: present # <value in [present, absent]>
hotspot20_h2qpadviceofcharge_aoclist:
name: "your value" # Required variable, string
# nai_realm: <string>
# nai_realm_encoding: <string>
# plan_info:
# - currency: <string>
# info_file: <string>
# lang: <string>
# name: <string>
# type: <value in [time-based, volume-based, time-and-volume-based, ...]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией 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_h2qpadviceofcharge_aoclist_module.html
