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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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` ← (default) `true`
enable_log boolean	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (default) `true`
fmupdate_fwmsetting_upgradetimeout dictionary	Набор параметров верхнего уровня.
check-status-timeout integer	Устарело, переименуйте в check_status_timeout. Время ожидания проверки состояния после установления туннеля.
ctrl-check-status-timeout integer	Устарело, переименуйте в ctrl_check_status_timeout. Время ожидания проверки состояния fap/fsw/fext после запроса обновления.
ctrl-put-image-by-fds-timeout integer	Устарело, переименуйте в ctrl_put_image_by_fds_timeout. Время ожидания получения устройством образа fap/fsw/fext из fort…
ha-sync-timeout integer	Устарело, переименуйте в ha_sync_timeout. Время ожидания синхронизации HA.
health-check-timeout integer	Устарело, переименуйте в health_check_timeout. Время ожидания получения.
license-check-timeout integer	Устарело, переименуйте в license_check_timeout. Время ожидания проверки лицензии FortiGate.
prepare-image-timeout integer	Устарело, переименуйте в prepare_image_timeout. Время ожидания подготовки образа.
put-image-by-fds-timeout integer	Устарело, переименуйте в put_image_by_fds_timeout. Время ожидания получения устройством образа от FortiGuard.
put-image-timeout integer	Устарело, переименуйте в put_image_timeout. Время ожидания отправки образа по туннелю.
reboot-of-fsck-timeout integer	Устарело, переименуйте в reboot_of_fsck_timeout. Время ожидания перезагрузки FortiGate.
reboot-of-upgrade-timeout integer	Устарело, переименуйте в reboot_of_upgrade_timeout. Время ожидания перезагрузки FortiGate после обновления образа.
retrieve-timeout integer	Устарело, переименуйте в retrieve_timeout. Время ожидания получения.
rpc-timeout integer	Устарело, переименуйте в rpc_timeout. Время ожидания ответа RPC FortiGate.
total-timeout integer	Устарело, переименуйте в total_timeout. Время ожидания всего процесса обновления FortiGate
forticloud_access_token string	Авторизация клиента Ansible с помощью токена доступа к API FortiCloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`

rc_failed список / элементы=целое число	Список кодов rc, при которых условие считается выполненным с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условие считается выполненным успешно.
workspace_locking_adom строка	ADOM для блокировки в режиме работы FortiManager в рабочем пространстве. Значение может быть глобальным и другими, включая корень.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь освободит блокировку рабочего пространства. По умолчанию: `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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure the timeout value of image upgrade process.
      fortinet.fortimanager.fmgr_fmupdate_fwmsetting_upgradetimeout:
        # 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, ...]
        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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_fmupdate_fwmsetting_upgradetimeout_module.html