Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_devprof_system_centralmanagement — настройка централизованного управления.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_devprof_system_centralmanagement.

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

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

Краткое описание

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

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

Варианты:

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

devprof

string / обязательный

Параметр (devprof) в запрошенном URL.

devprof_system_centralmanagement

dictionary

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

allow_monitor

aliases: allow-monitor

string

Включить или отключить возможность удаленного мониторинга этого устройства FortiGate сервером централизованного управления.

Варианты:

  • "disable"
  • "enable"

allow_push_configuration

aliases: allow-push-configuration

string

Включить или отключить возможность отправки изменений конфигурации на это устройство FortiGate сервером централизованного управления.

Варианты:

  • "disable"
  • "enable"

allow_push_firmware

aliases: allow-push-firmware

string

Включить или отключить возможность отправки обновлений прошивки на это устройство FortiGate сервером централизованного управления.

Варианты:

  • "disable"
  • "enable"

allow_remote_firmware_upgrade

aliases: allow-remote-firmware-upgrade

string

Включить или отключить удаленное обновление прошивки этого устройства FortiGate с сервера централизованного управления.

Варианты:

  • "disable"
  • "enable"

allow_remote_lte_firmware_upgrade

aliases: allow-remote-lte-firmware-upgrade

string

Включить или отключить удаленное обновление прошивки LTE этого устройства FortiGate с сервера централизованного управления.

Варианты:

  • "disable"
  • "enable"

allow_remote_modem_firmware_upgrade

aliases: allow-remote-modem-firmware-upgrade

string

Включить или отключить удаленное обновление прошивки встроенного сотового модема этого устройства FortiGate с сервера централизованного управления.

Варианты:

  • "disable"
  • "enable"

ca_cert

aliases: ca-cert

string

Сертификат CA, используемый протоколом FGFM.

enc_algorithm

aliases: enc-algorithm

string

Стойкость шифрования для связи между FortiGate и сервером централизованного управления.

Варианты:

  • "default"
  • "high"
  • "low"

fmg

any

(список) IP-адрес или FQDN FortiManager.

fmg_source_ip

aliases: fmg-source-ip

string

Исходный IPv4-адрес, который это устройство FortiGate использует для связи с FortiManager.

fmg_source_ip6

aliases: fmg-source-ip6

string

Исходный IPv6-адрес, который это устройство FortiGate использует для связи с FortiManager.

fmg_update_http_header

aliases: fmg-update-http-header

string

Включить или отключить добавление заголовка HTTP в запрос на обновление.

Варианты:

  • "disable"
  • "enable"

fmg_update_port

aliases: fmg-update-port

string

Порт для связи с FortiManager, выполняющим роль сервера обновлений FortiGuard.

Варианты:

  • "443"
  • "8890"

fortigate_cloud_sso_default_profile

aliases: fortigate-cloud-sso-default-profile

any

(список) Переопределить профиль доступа.

include_default_servers

aliases: include-default-servers

string

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

Варианты:

  • "disable"
  • "enable"

interface

any

(список) Укажите исходящий интерфейс для связи с сервером.

interface_select_method

aliases: interface-select-method

string

Укажите способ выбора исходящего интерфейса для связи с сервером.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

local_cert

aliases: local-cert

string

Сертификат, используемый протоколом FGFM.

ltefw_upgrade_frequency

aliases: ltefw-upgrade-frequency

string

Задайте периодичность автоматической отправки прошивки LTE.

Варианты:

  • "everyHour"
  • "every12hour"
  • "everyDay"
  • "everyWeek"

ltefw_upgrade_time

aliases: ltefw-upgrade-time

string

Запланируйте время следующего обновления прошивки LTE

mode

string

Режим централизованного управления.

Варианты:

  • "normal"
  • "backup"

modem_upgrade_frequency

aliases: modem-upgrade-frequency

string

Задайте периодичность автоматической отправки прошивки встроенного сотового модема.

Варианты:

  • "everyHour"
  • "every12hour"
  • "everyDay"
  • "everyWeek"

modem_upgrade_time

aliases: modem-upgrade-time

string

Запланируйте время следующего обновления прошивки встроенного сотового модема

schedule_config_restore

aliases: schedule-config-restore

string

Включить или отключить возможность восстановления конфигурации этого устройства FortiGate сервером централизованного управления.

Варианты:

  • "disable"
  • "enable"

schedule_script_restore

aliases: schedule-script-restore

string

Включить или отключить возможность восстановления скриптов, хранящихся на этом устройстве FortiGate, сервером централизованного управления.

Варианты:

  • "disable"
  • "enable"

serial_number

aliases: serial-number

any

(список) Серийный номер.

server_list

aliases: server-list

list / elements=dictionary

Список серверов.

addr_type

aliases: addr-type

string

Указывает, использует ли FortiGate для связи с сервером переопределения IPv4-адрес, IPv6-адрес или FQDN.

Варианты:

  • "fqdn"
  • "ipv4"
  • "ipv6"

fqdn

string

FQDN-адрес сервера переопределения.

id

integer

Идентификатор.

server_address

aliases: server-address

string

IPv4-адрес сервера переопределения.

server_address6

aliases: server-address6

string

IPv6-адрес сервера переопределения.

server_type

aliases: server-type

list / elements=string

Тип службы FortiGuard.

Варианты:

  • "update"
  • "rating"
  • "iot-query"
  • "iot-collect"
  • "vpatch-query"

type

string

Тип централизованного управления.

Варианты:

  • "fortimanager"
  • "fortiguard"
  • "none"

use_elbc_vdom

aliases: use-elbc-vdom

string

Включить или отключить использование специального VDOM синхронизации конфигурации ELBC для подключения к FortiManager.

Варианты:

  • "disable"
  • "enable"

vdom

any

(список) Виртуальный домен

vrf_select

aliases: vrf-select

integer

Идентификатор VRF, используемый для подключения к серверу.

enable_log

boolean

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

Варианты:

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

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

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 central management.
      fortinet.fortimanager.fmgr_devprof_system_centralmanagement:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        devprof: <your own value>
        devprof_system_centralmanagement:
          # include_default_servers: <value in [disable, enable]>
          # server_list:
          #   - addr_type: <value in [fqdn, ipv4, ipv6]>
          #     fqdn: <string>
          #     id: <integer>
          #     server_address: <string>
          #     server_address6: <string>
          #     server_type: ["update", "rating", "iot-query", "iot-collect", "vpatch-query"]
          # ltefw_upgrade_time: <string>
          # vdom: <list or string>
          # allow_remote_firmware_upgrade: <value in [disable, enable]>
          # local_cert: <string>
          # allow_push_firmware: <value in [disable, enable]>
          # ltefw_upgrade_frequency: <value in [everyHour, every12hour, everyDay, ...]>
          # mode: <value in [normal, backup]>
          # serial_number: <list or string>
          # fmg_source_ip6: <string>
          # allow_monitor: <value in [disable, enable]>
          # allow_push_configuration: <value in [disable, enable]>
          # ca_cert: <string>
          # fmg_update_port: <value in [443, 8890]>
          # use_elbc_vdom: <value in [disable, enable]>
          # allow_remote_lte_firmware_upgrade: <value in [disable, enable]>
          # interface: <list or string>
          # schedule_script_restore: <value in [disable, enable]>
          # schedule_config_restore: <value in [disable, enable]>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # type: <value in [fortimanager, fortiguard, none]>
          # fmg_source_ip: <string>
          # fortigate_cloud_sso_default_profile: <list or string>
          # fmg: <list or string>
          # enc_algorithm: <value in [default, high, low]>
          # allow_remote_modem_firmware_upgrade: <value in [disable, enable]>
          # modem_upgrade_frequency: <value in [everyHour, every12hour, everyDay, ...]>
          # modem_upgrade_time: <string>
          # vrf_select: <integer>
          # fmg_update_http_header: <value in [disable, enable]>

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

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

Ключ

Описание

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

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

Spec-Zone.ru

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