модуль fortinet.fortios.fortios_system_federated_upgrade — Координация федеративных обновлений в Security Fabric в 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_federated_upgrade.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию system и категорию federated_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 игнорируется. Варианты:
|
system_federated_upgrade dictionary | Координация федеративных обновлений в Security Fabric. |
|
failure_device string |
Серийный номер узла, который нужно включить. |
|
failure_reason string |
Причина сбоя обновления. Варианты:
|
|
ha_reboot_controller string |
Серийный номер устройства FortiGate, которое будет управлять процессом перезагрузки при федеративном обновлении кластера HA. |
|
ignore_signing_errors string |
Разрешить/запретить использование неподписанных образов прошивки FortiGate. Варианты:
|
|
initial_version string |
Версия прошивки на момент настройки обновления. |
|
known_ha_members list / elements=dictionary |
Известные участники кластера HA. Если во время обновления какой-либо участник отсутствует, обновление будет отменено. |
|
serial string / обязательный |
Серийный номер участника HA |
|
next_path_index integer |
Индекс следующего образа для обновления. |
|
node_list list / elements=dictionary |
Узлы, которые будут включены в обновление. |
|
allow_download string |
Включить/отключить загрузку образов прошивки. Варианты:
|
|
coordinating_fortigate string |
Серийный номер устройства FortiGate, управляющего этим устройством. |
|
device_type string |
Тип устройства Fortinet. Варианты:
|
|
failure_reason string |
Причина сбоя обновления. Варианты:
|
|
maximum_minutes integer |
Максимальное количество минут, отведенное на подготовку к немедленному обновлению. |
|
serial string / обязательный |
Серийный номер узла, который нужно включить. |
|
setup_time string |
Время начала подготовки к обновлению в UTC (чч:мм гггг/мм/дд UTC). |
|
time string |
Запланированное время выполнения обновления в UTC (чч:мм гггг/мм/дд UTC). |
|
timing string |
Выполнить немедленно или в запланированное время. Варианты:
|
|
upgrade_path string |
Версии образов Fortinet OS, используемые для последовательного обновления, в формате «основная-дополнительная-исправление», например 7-0-4. |
|
source string |
Источник, из которого была настроена конфигурация федеративного обновления. Варианты:
|
|
starter_admin string |
Администратор, запустивший обновление. |
|
status string |
Текущее состояние обновления. Варианты:
|
|
upgrade_id integer |
Уникальный идентификатор этого обновления. |
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков рекомендуется использовать httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Coordinate federated upgrades within the Security Fabric.
fortinet.fortios.fortios_system_federated_upgrade:
vdom: "{{ vdom }}"
system_federated_upgrade:
failure_device: "<your_own_value>"
failure_reason: "none"
ha_reboot_controller: "<your_own_value>"
ignore_signing_errors: "enable"
initial_version: "<your_own_value>"
known_ha_members:
-
serial: "<your_own_value>"
next_path_index: "0"
node_list:
-
allow_download: "enable"
coordinating_fortigate: "<your_own_value>"
device_type: "fortigate"
failure_reason: "none"
maximum_minutes: "15"
serial: "<your_own_value>"
setup_time: "<your_own_value>"
time: "<your_own_value>"
timing: "immediate"
upgrade_path: "<your_own_value>"
source: "user"
starter_admin: "<your_own_value>"
status: "disabled"
upgrade_id: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_federated_upgrade_module.html