Модуль fortinet.fortimanager.fmgr_wtpprofile_platform — платформа WTP, FortiAP или AP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_wtpprofile_platform.
Добавлено в fortinet.fortimanager 2.0.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. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Допустимые значения:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. Значением может быть global и другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочего пространства другим пользователем. По умолчанию: |
wtp-profile string | Устарел, используйте “wtp_profile”. |
wtp_profile string | Параметр (wtp-profile) в запрошенном URL. |
wtpprofile_platform dictionary | Набор параметров верхнего уровня. |
|
_local_platform_str string |
Строка локальной платформы. |
|
ddscan string |
Включить или отключить использование одного радиомодуля для специализированного двухдиапазонного сканирования с целью обнаружения характеристик радиочастотного спектра и управления угрозами беспроводной сети. Допустимые значения:
|
|
mode string |
Настроить режим работы радиомодулей 5G. Допустимые значения:
|
|
type string |
Тип платформы WTP, FortiAP или AP. Допустимые значения:
|
Примечания
Примечание
- Начиная с версии 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.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: WTP, FortiAP, or AP platform.
fortinet.fortimanager.fmgr_wtpprofile_platform:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
wtp_profile: <your own value>
wtpprofile_platform:
# type: <value in [30B-50B, 60B, 80CM-81CM, ...]>
# mode: <value in [dual-5G, single-5G]>
# ddscan: <value in [disable, enable]>
# _local_platform_str: <string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_wtpprofile_platform_module.html
