модуль fortinet.fortios.fortios_system_device_upgrade — Независимое обновление управляемых устройств в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_device_upgrade.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функции системы и категорию device_upgrade. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Протестировано с FOS v6.0.0
Требования
На хосте, где выполняется этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, с которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
system_device_upgrade dictionary | Независимое обновление управляемых устройств. |
|
allow_download string |
Включить или отключить загрузку образов прошивки. Варианты:
|
|
device_type string |
Тип устройства Fortinet. Варианты:
|
|
failure_reason string |
Причина сбоя обновления. Варианты:
|
|
ha_reboot_controller string |
Серийный номер устройства FortiGate, которое будет управлять процессом перезагрузки во время федеративного обновления кластера HA. |
|
initial_version string |
Версия прошивки на момент настройки обновления. |
|
known_ha_members list / элементы=dictionary |
Известные участники кластера HA. Если во время обновления участник отсутствует, обновление будет отменено. |
|
serial string / обязательный |
Серийный номер участника HA |
|
maximum_minutes integer |
Максимальное количество минут, отведенное на немедленную подготовку к обновлению. |
|
next_path_index integer |
Индекс следующего образа для обновления. |
|
serial string / обязательный |
Серийный номер добавляемого узла. |
|
setup_time string |
Время начала подготовки к обновлению в формате UTC (hh:mm yyyy/mm/dd UTC). |
|
starter_admin string |
Администратор, запустивший обновление. |
|
status string |
Текущий статус обновления. Варианты:
|
|
time string |
Запланированное время выполнения обновления в формате UTC (hh:mm yyyy/mm/dd UTC). |
|
timing string |
Запустить немедленно или в запланированное время. Варианты:
|
|
upgrade_path string |
Версии образов Fortinet OS, через которые необходимо выполнить обновление, в формате «основная-дополнительная-исправление», например 7-0-4. |
|
vdom string |
Ограничить обновление этим виртуальным доменом (VDOM). Источник: system.vdom.name. |
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Independent upgrades for managed devices.
fortinet.fortios.fortios_system_device_upgrade:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_device_upgrade:
allow_download: "enable"
device_type: "fortigate"
failure_reason: "none"
ha_reboot_controller: "<your_own_value>"
initial_version: "<your_own_value>"
known_ha_members:
-
serial: "<your_own_value>"
maximum_minutes: "15"
next_path_index: "0"
serial: "<your_own_value>"
setup_time: "<your_own_value>"
starter_admin: "<your_own_value>"
status: "disabled"
time: "<your_own_value>"
timing: "immediate"
upgrade_path: "<your_own_value>"
vdom: "<your_own_value> (source system.vdom.name)"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращенный FortiGate после последней выполненной операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_system_device_upgrade_module.html