Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.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

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

fmupdate_fwmsetting

dictionary

Набор параметров верхнего уровня.

auto_scan_fgt_disk

псевдонимы: auto-scan-fgt-disk

string

Автоматически сканировать диск FGT при необходимости.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

check_fgt_disk

псевдонимы: check-fgt-disk

string

Проверять диск FGT перед обновлением образа.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

fds_failover_fmg

псевдонимы: fds-failover-fmg

string

Использовать локальный файл образа FMG, если загрузка с FDS завершается с ошибкой.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

fds_image_timeout

псевдонимы: fds-image-timeout

integer

Тайм-аут загрузки образа с FortiGuard на FGT.

health_check

псевдонимы: health-check

string

Выполнять проверку работоспособности после обновления.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

immx_source

псевдонимы: immx-source

string

Настроить, какой файл IMMX использовать для выбора пути обновления.

fmg — использовать файл IMMX для FortiManager

fgt — использовать файл IMMX для FortiGate

cloud — использовать файл IMMX для FortiCloud

Варианты:

  • "fmg"
  • "fgt"
  • "cloud"

log

string

Настроить параметры журнала для демона 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

integer

Максимальное количество отчетов об обновлении устройств.

max_fds_retry

псевдонимы: max-fds-retry

integer

Количество повторных попыток, если загрузка с FDS на FGT завершается с ошибкой.

max_profile_history

псевдонимы: max-profile-history

integer

Максимальное количество отчетов об обновлении профилей.

multiple_steps_interval

псевдонимы: multiple-steps-interval

integer

Время ожидания между этапами многоэтапного обновления.

retrieve

string

Выполнять получение данных после обновления.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

retry_interval

псевдонимы: retry-interval

integer

Время ожидания перед повторной отправкой запроса устройству.

retry_max

псевдонимы: retry-max

integer

Максимальное количество повторных попыток.

revision_diff

псевдонимы: revision-diff

string

Вычислять различия в сценарии после обновления.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

send_image_retry

псевдонимы: send-image-retry

integer

Повторять отправку образа в случае сбоя.

skip_disk_check

псевдонимы: skip-disk-check

string

Пропускать проверку диска при обновлении образа.

disable — отключить параметр.

enable — включить параметр.

Варианты:

  • "disable"
  • "enable"

upgrade_timeout

псевдонимы: upgrade-timeout

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 / элементы=integer

Список кодов rc, переопределяющий условия, при которых операция считается неудачной.

rc_succeeded

list / элементы=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 firmware management settings.
      fortinet.fortimanager.fmgr_fmupdate_fwmsetting:
        # workspace_locking_adom: <global or your adom name>
        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]>
          # send_image_retry: <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

Предупреждение о том, что параметры, используемые в сценарии 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–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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API