модуль fortinet.fortimanager.fmgr_fmupdate_fwmsetting_upgradetimeout — настройка значения тайм-аута процесса обновления образа.

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_fmupdate_fwmsetting_upgradetimeout.

Добавлено в fortinet.fortimanager 2.2.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
fmupdate_fwmsetting_upgradetimeout dictionary	Набор параметров верхнего уровня.
check_status_timeout псевдонимы: check-status-timeout integer	Тайм-аут проверки состояния после установления туннеля.
ctrl_check_status_timeout псевдонимы: ctrl-check-status-timeout integer	Тайм-аут проверки состояния fap/fsw/fext после запроса на обновление.
ctrl_put_image_by_fds_timeout псевдонимы: ctrl-put-image-by-fds-timeout integer	Тайм-аут ожидания загрузки устройством образа fap/fsw/fext из FortiGuard.
ha_sync_timeout псевдонимы: ha-sync-timeout integer	Тайм-аут ожидания синхронизации HA.
health_check_timeout псевдонимы: health-check-timeout integer	Тайм-аут ожидания получения данных.
license_check_timeout псевдонимы: license-check-timeout integer	Тайм-аут ожидания проверки лицензии FortiGate.
prepare_image_timeout псевдонимы: prepare-image-timeout integer	Тайм-аут подготовки образа.
put_image_by_fds_timeout псевдонимы: put-image-by-fds-timeout integer	Тайм-аут ожидания загрузки устройством образа из FortiGuard.
put_image_timeout псевдонимы: put-image-timeout integer	Тайм-аут ожидания отправки образа через туннель.
reboot_of_fsck_timeout псевдонимы: reboot-of-fsck-timeout integer	Тайм-аут ожидания перезагрузки FortiGate.
reboot_of_upgrade_timeout псевдонимы: reboot-of-upgrade-timeout integer	Тайм-аут ожидания перезагрузки FortiGate после обновления образа.
retrieve_timeout псевдонимы: retrieve-timeout integer	Тайм-аут ожидания получения данных.
rpc_timeout псевдонимы: rpc-timeout integer	Тайм-аут ожидания ответа RPC от FortiGate.
total_timeout псевдонимы: total-timeout integer	Тайм-аут всего процесса обновления FortiGate.
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, при которых выполнение считается неудачным; позволяет переопределить соответствующие условия.
rc_succeeded list / elements=integer	Список кодов rc, при которых выполнение считается успешным; позволяет переопределить соответствующие условия.
workspace_locking_adom string	ADOM, который следует заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая 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.
Обычно выполнение одного модуля может завершиться с ошибкой, если возвращён ненулевой код rc. Условия завершения с ошибкой или успехом также можно переопределить с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure the timeout value of image upgrade process.
      fortinet.fortimanager.fmgr_fmupdate_fwmsetting_upgradetimeout:
        # workspace_locking_adom: <global or your adom name>
        fmupdate_fwmsetting_upgradetimeout:
          # check_status_timeout: <integer>
          # ctrl_check_status_timeout: <integer>
          # ctrl_put_image_by_fds_timeout: <integer>
          # ha_sync_timeout: <integer>
          # license_check_timeout: <integer>
          # prepare_image_timeout: <integer>
          # put_image_by_fds_timeout: <integer>
          # put_image_timeout: <integer>
          # reboot_of_fsck_timeout: <integer>
          # reboot_of_upgrade_timeout: <integer>
          # retrieve_timeout: <integer>
          # rpc_timeout: <integer>
          # total_timeout: <integer>
          # health_check_timeout: <integer>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Состояние запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Состояние запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_fmupdate_fwmsetting_upgradetimeout_module.html