Модуль fortinet.fortios.fortios_system_federated_upgrade – Координация федеративных обновлений в Security Fabric в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
Эта коллекция, возможно, уже установлена, если вы используете пакет 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), позволяя пользователю устанавливать и изменять категорию системных функций и federated_upgrade. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано в интерфейсе Fortigate. |
enable_log логический тип | Включить/отключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для работы. Разделяется с помощью слеша, если атрибутов несколько. Параметр, помеченный member_path, подходит для выполнения операций с членами. |
member_state строка | Добавить или удалить члена по указанному пути к атрибуту. Когда member_state задан, параметр state игнорируется. Варианты:
|
system_federated_upgrade словарь | Координировать федеративные обновления в Security Fabric. |
|
failure_device строка |
Серийный номер узла для включения. |
|
failure_reason строка |
Причина сбоя обновления. Варианты:
|
|
ha_reboot_controller строка |
Серийный номер устройства FortiGate, которое будет контролировать процесс перезагрузки для федеративного обновления кластера HA. |
|
known_ha_members список / элементы=словарь |
Известные члены кластера HA. Если член отсутствует во время обновления, обновление будет отменено. |
|
serial строка / обязательно |
Серийный номер члена HA |
|
next_path_index целое число |
Индекс следующей версии образа для обновления. |
|
node_list список / элементы=словарь |
Узлы, которые будут включены в обновление. |
|
coordinating_fortigate строка |
Серийный номер устройства FortiGate, которое управляет этим устройством. |
|
device_type строка |
Тип устройства Fortinet. Варианты:
|
|
maximum_minutes целое число |
Максимальное количество минут, разрешенное для немедленной подготовки обновления. |
|
serial строка / обязательно |
Серийный номер узла для включения. |
|
setup_time строка |
Время начала подготовки обновления по UTC (чч:мм гггг/мм/дд UTC). |
|
time строка |
Время запланированного выполнения обновления по UTC (чч:мм гггг/мм/дд UTC). |
|
timing строка |
Выполнить немедленно или в запланированное время. Варианты:
|
|
upgrade_path строка |
Версии изображений Fortinet OS для обновления в формате major-minor-patch, например 7-0-4. |
|
status string |
Текущий статус обновления. Варианты:
|
|
upgrade_id integer |
Уникальный идентификатор этого обновления. |
vdom string | Виртуальный домен, среди тех, которые были определены ранее. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный модуль. Значение по умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi был объявлен устаревшим, httpapi — предпочтительный способ запуска playbooks
Примеры
- 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>"
known_ha_members:
-
serial: "<your_own_value>"
next_path_index: "0"
node_list:
-
coordinating_fortigate: "<your_own_value>"
device_type: "fortigate"
maximum_minutes: "15"
serial: "<your_own_value>"
setup_time: "<your_own_value>"
time: "<your_own_value>"
timing: "immediate"
upgrade_path: "<your_own_value>"
status: "disabled"
upgrade_id: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при последней применённой операции Возвращается: всегда Пример: |
mkey string | Главный ключ (id), использованный в последнем вызове FortiGate Возвращается: успех Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Указание результата операции Возвращается: всегда Пример: |
vdom string | Использованный виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_system_federated_upgrade_module.html
