fortinet.fortimanager.fmgr_fmupdate_fwmsetting модуль — Настройка параметров управления прошивкой.

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_fmupdate_fwmsetting.

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

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

Описание

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое значение	Устанавливается в значение True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включение/выключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
fmupdate_fwmsetting словарь	Настройка параметров верхнего уровня.
auto_scan_fgt_disk строка	Устаревшее, пожалуйста, переименуйте в auto_scan_fgt_disk. Автосканирование диска FGT при необходимости. disable — Отключить настройку. enable — Включить настройку. Варианты: `"disable"` `"enable"`
check_fgt_disk строка	Устаревшее, пожалуйста, переименуйте в check_fgt_disk. Проверка диска FGT перед обновлением образа. disable — Отключить настройку. enable — Включить настройку. Варианты: `"disable"` `"enable"`
fds_failover_fmg строка	Устаревшее, пожалуйста, переименуйте в fds_failover_fmg. Использование локального образа fmg с fds при сбоях загрузки. disable — Отключить настройку. enable — Включить настройку. Варианты: `"disable"` `"enable"`
fds_image_timeout целое число	Устаревшее, пожалуйста, переименуйте в fds_image_timeout. Таймер для загрузки образа fgt с fortiguard.
health_check строка	Устаревшее, пожалуйста, переименуйте в health_check. Проверка работоспособности после обновления. disable — Отключить настройку. enable — Включить настройку. Варианты: `"disable"` `"enable"`
immx_source строка	Устаревшее, пожалуйста, переименуйте в immx_source. Настройка файла IMMX для выбора обновления. fmg — Использование файла IMMX для FortiManager. fgt — Использование файла IMMX для FortiGate. cloud — Использование файла IMMX для FortiCloud. Варианты: `"fmg"` `"fgt"` `"cloud"`
log строка	Настройка параметров ведения журнала для демона fwm. fwm — Журнал демона FWM. fwm_dm — Журнал FWM и службы развертывания. fwm_dm_json — Журнал FWM и службы развертывания с данными JSON между FMG и FGT. Варианты: `"fwm"` `"fwm_dm"` `"fwm_dm_json"`
max_device_history целое число	Устаревшее, пожалуйста, переименуйте в max_device_history. Максимальное количество отчетов об обновлении устройств.
max_fds_retry целое число	Устаревшее, пожалуйста, переименуйте в max_fds_retry. Повторные попытки при неудачной загрузке с fds.
max_profile_history целое число	Устаревшее, пожалуйста, переименуйте в max_profile_history. Максимальное количество отчетов об обновлении профилей.
multiple_steps_interval целое число	Устаревшее, пожалуйста, переименуйте в multiple_steps_interval. Время ожидания между несколькими этапами обновления.
retrieve строка	Выполнение операции retrieve после обновления. disable — Отключить настройку. enable — Включить настройку. Варианты: `"disable"` `"enable"`
retry_interval целое число	Устаревшее, пожалуйста, переименуйте в retry_interval. Время ожидания для повторной отправки запроса на устройство.
retry_max целое число	Устаревшее, пожалуйста, переименуйте в retry_max. Максимальное количество попыток.

revision-diff string	Устарело, переименуйте в revision_diff. Вычислить скрипт diff после обновления disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
skip-disk-check string	Устарело, переименуйте в skip_disk_check. Пропустить проверку диска при обновлении образа. disable - Отключить настройку. enable - Включить настройку. Варианты: `"disable"` `"enable"`
upgrade-timeout dictionary	Устарело, переименуйте в upgrade_timeout. Время ожидания обновления.
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 f…
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 list / elements=integer	Список кодов rc, с которыми будут переопределены условия неудачи.
rc_succeeded list / elements=integer	Список кодов 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_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 firmware management settings.
      fortinet.fortimanager.fmgr_fmupdate_fwmsetting:
        # 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:
          fds_image_timeout: <integer>
          max_fds_retry: <integer>
          multiple_steps_interval: <integer>
          skip_disk_check: <value in [disable, enable]>
          auto_scan_fgt_disk: <value in [disable, enable]>
          check_fgt_disk: <value in [disable, enable]>
          fds_failover_fmg: <value in [disable, enable]>
          immx_source: <value in [fmg, fgt, cloud]>
          log: <value in [fwm, fwm_dm, fwm_dm_json]>
          upgrade_timeout:
            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>
          retry_interval: <integer>
          retry_max: <integer>
          health_check: <value in [disable, enable]>
          max_device_history: <integer>
          max_profile_history: <integer>
          retrieve: <value in [disable, enable]>
          revision_diff: <value in [disable, enable]>

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

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

Ключ	Описание
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_module.html