fortinet.fortimanager.fmgr_system_dm module – Настройка dm.

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
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, которыми переопределяются условия успешного выполнения.
system_dm dictionary	Параметры верхнего уровня.
autoupdate_merge_revision псевдонимы: autoupdate-merge-revision string	Объединение ревизий при автоматическом обновлении. Варианты: `"disable"` `"enable"`
concurrent_install_image_limit псевдонимы: concurrent-install-image-limit integer	Максимальное количество одновременных установок образов
concurrent_install_limit псевдонимы: concurrent-install-limit integer	Максимальное количество одновременных установок
concurrent_install_script_limit псевдонимы: concurrent-install-script-limit integer	Максимальное количество одновременно устанавливаемых сценариев
conf_merge_after_script псевдонимы: conf-merge-after-script string	Объединять конфигурацию после запуска сценария на удалённом устройстве вместо полного получения конфигурации. disable — отключить. enable — включить. Варианты: `"disable"` `"enable"`
discover_timeout псевдонимы: discover-timeout integer	Тайм-аут проверки подключения при обнаружении устройства
dpm_logsize псевдонимы: dpm-logsize integer	Максимальный размер журнала dpm для каждого устройства
fgfm_auto_retrieve_timeout псевдонимы: fgfm-auto-retrieve-timeout integer	Максимальное время ожидания автоматического получения данных
fgfm_install_refresh_count псевдонимы: fgfm-install-refresh-count integer	Максимальное количество попыток обновления установки FGFM.
fgfm_keepalive_itvl integer	Интервал keep-alive протокола FGFM
fgfm_sock_timeout псевдонимы: fgfm-sock-timeout integer	Максимальное время простоя сокета FGFM
force_remote_diff псевдонимы: force-remote-diff string	Всегда использовать удалённое сравнение различий при установке. disable — отключить. enable — включить. Варианты: `"disable"` `"enable"`
fortiap_refresh_cnt псевдонимы: fortiap-refresh-cnt integer	Максимальное количество FortiAP для автоматического обновления за один раз
fortiap_refresh_itvl псевдонимы: fortiap-refresh-itvl integer	Интервал автоматического обновления состояния FortiAP
fortiext_refresh_cnt псевдонимы: fortiext-refresh-cnt integer	Максимальное количество устройств для автоматического обновления FortiExtender
handle_nonhasync_config псевдонимы: handle-nonhasync-config string	Включить или отключить обработку конфигурации nonhasync. disable — отключить. enable — включить. Варианты: `"disable"` `"enable"`
install_fds_timeout псевдонимы: install-fds-timeout integer	Максимальное время ожидания обновления fgt во время установки
install_image_timeout псевдонимы: install-image-timeout integer	Максимальное время ожидания передачи образа и обновления устройства
install_tunnel_retry_itvl псевдонимы: install-tunnel-retry-itvl integer	Время повторного установления туннеля во время установки
log_autoupdate псевдонимы: log-autoupdate string	Включить или отключить отладочное ведение журнала автоматического обновления. disable — отключить. enable — включить. Варианты: `"disable"` `"enable"`
max_revs псевдонимы: max-revs integer	Максимальное количество сохраняемых ревизий
nr_retry псевдонимы: nr-retry integer	Количество повторных попыток.
retry string	Включить или отключить повторные попытки установки конфигурации. disable — отключить. enable — включить. Варианты: `"disable"` `"enable"`
retry_intvl псевдонимы: retry-intvl integer	Интервал между повторными попытками.
rollback_allow_reboot псевдонимы: rollback-allow-reboot string	Разрешить или запретить перезагрузку FortiGate для отката при установке сценария или конфигурации. disable — отключить. enable — включить. Варианты: `"disable"` `"enable"`
script_logsize псевдонимы: script-logsize integer	Максимальный размер журнала сценариев для каждого устройства
skip_scep_check псевдонимы: skip-scep-check string	Разрешить или запретить установку объектов, связанных с scep, даже если настроен URL-адрес scep. disable — отключить. enable — включить. Варианты: `"disable"` `"enable"`
skip_tunnel_fcp_req псевдонимы: skip-tunnel-fcp-req string	Включить или отключить пропуск запроса fcp, отправленного через туннель fgfm disable — отключить. enable — включить. Варианты: `"disable"` `"enable"`
verify_install псевдонимы: verify-install string	Проверять установку по удалённой конфигурации. disable — отключить. optimal — проверять установку на наличие ошибок команд. enable — всегда проверять установку. Варианты: `"disable"` `"optimal"` `"enable"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме workspace. Значением может быть global или другое имя, включая 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 dm.
      fortinet.fortimanager.fmgr_system_dm:
        # workspace_locking_adom: <global or your adom name>
        system_dm:
          # concurrent_install_image_limit: <integer>
          # concurrent_install_limit: <integer>
          # concurrent_install_script_limit: <integer>
          # discover_timeout: <integer>
          # dpm_logsize: <integer>
          # fgfm_sock_timeout: <integer>
          # fgfm_keepalive_itvl: <integer>
          # force_remote_diff: <value in [disable, enable]>
          # fortiap_refresh_cnt: <integer>
          # fortiap_refresh_itvl: <integer>
          # fortiext_refresh_cnt: <integer>
          # install_image_timeout: <integer>
          # install_tunnel_retry_itvl: <integer>
          # max_revs: <integer>
          # nr_retry: <integer>
          # retry: <value in [disable, enable]>
          # retry_intvl: <integer>
          # rollback_allow_reboot: <value in [disable, enable]>
          # script_logsize: <integer>
          # skip_scep_check: <value in [disable, enable]>
          # skip_tunnel_fcp_req: <value in [disable, enable]>
          # verify_install: <value in [disable, optimal, enable]>
          # fgfm_install_refresh_count: <integer>
          # conf_merge_after_script: <value in [disable, enable]>
          # log_autoupdate: <value in [disable, enable]>
          # fgfm_auto_retrieve_timeout: <integer>
          # install_fds_timeout: <integer>
          # handle_nonhasync_config: <value in [disable, enable]>
          # autoupdate_merge_revision: <value in [disable, enable]>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL-адрес запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в сценарии, не поддерживаются текущей версией 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_system_dm_module.html