модуль fortinet.fortimanager.fmgr_gtp_rattimeoutprofile — профиль тайм-аутов RAT
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Эта коллекция уже может быть установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_gtp_rattimeoutprofile.
Добавлено в fortinet.fortimanager 2.10.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. |
gtp_rattimeoutprofile dictionary | Набор параметров верхнего уровня. |
|
eutran_timeout псевдонимы: eutran-timeout integer |
Тайм-аут установленного соединения E-UTRAN в секундах |
|
gan_timeout псевдонимы: gan-timeout integer |
Тайм-аут установленного соединения GAN в секундах |
|
geran_timeout псевдонимы: geran-timeout integer |
Тайм-аут установленного соединения GERAN в секундах |
|
hspa_timeout псевдонимы: hspa-timeout integer |
Тайм-аут установленного соединения HSPA в секундах |
|
ltem_timeout псевдонимы: ltem-timeout integer |
Тайм-аут установленного соединения LTE-M в секундах |
|
name string / обязательный |
Имя профиля тайм-аутов RAT. |
|
nbiot_timeout псевдонимы: nbiot-timeout integer |
Тайм-аут установленного соединения NB-IoT в секундах |
|
nr_timeout псевдонимы: nr-timeout integer |
Тайм-аут установленного соединения NR в секундах |
|
utran_timeout псевдонимы: utran-timeout integer |
Тайм-аут установленного соединения UTRAN в секундах |
|
virtual_timeout псевдонимы: virtual-timeout integer |
Тайм-аут установленного виртуального соединения в секундах |
|
wlan_timeout псевдонимы: wlan-timeout integer |
Тайм-аут установленного соединения WLAN в секундах |
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 и другие варианты, включая 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: RAT timeout profile
fortinet.fortimanager.fmgr_gtp_rattimeoutprofile:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
gtp_rattimeoutprofile:
name: "your value" # Required variable, string
# eutran_timeout: <integer>
# gan_timeout: <integer>
# geran_timeout: <integer>
# hspa_timeout: <integer>
# ltem_timeout: <integer>
# nbiot_timeout: <integer>
# nr_timeout: <integer>
# utran_timeout: <integer>
# virtual_timeout: <integer>
# wlan_timeout: <integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_gtp_rattimeoutprofile_module.html
