fortinet.fortimanager.fmgr_hotspot20_h2qpadviceofcharge модуль — Настройка уведомлений об оплате.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_hotspot20_h2qpadviceofcharge.
Новое в fortinet.fortimanager 2.1.0
Описание
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в значение True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью токена доступа к API forticloud. |
hotspot20_h2qpadviceofcharge словарь | Настройка параметров верхнего уровня. |
|
aoc_list список / элементы=словарь |
Устарело, пожалуйста, переименуйте на aoc_list. Список сборов платы. |
|
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 строка |
Тип сборов платы. Варианты:
|
|
name строка / обязательно |
Название плана. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое | Список rc-кодов, с которыми будут переопределены условия для ошибки. |
rc_succeeded список / элементы=целое | Список rc-кодов, с которыми будут переопределены условия для успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | Область для блокировки FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая 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 помогают в этом.
- Для создания или обновления объекта используйте директиву 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 advice of charge.
fortinet.fortimanager.fmgr_hotspot20_h2qpadviceofcharge:
# 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_h2qpadviceofcharge:
aoc_list:
-
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, ...]>
name: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
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–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_module.html
