fortinet.fortimanager.fmgr_system_dm модуль — Настройка dm.

Примечание

Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Выбираемые значения: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/выключить ведение журнала для задачи. Выбираемые значения: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для запроса Json RPC. Выбираемые значения: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми условия отказа будут переопределены.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми условия успеха будут переопределены.
system_dm словарь	Установленные параметры верхнего уровня.
concurrent_install_image_limit целое число	Максимальное количество одновременных установок образов.
concurrent_install_limit целое число	Максимальное количество одновременных установок.
concurrent_install_script_limit целое число	Максимальное количество одновременных установок скриптов.
conf_merge_after_script строка	Слияние конфигурации после выполнения скрипта на удалённом устройстве вместо полного извлечения. disable - Выключить. enable - Включить. Выбираемые значения: `"disable"` `"enable"`
discover_timeout целое число	Таймаут проверки подключения при обнаружении устройства.
dpm_logsize целое число	Максимальный размер журнала dpm на устройство.
fgfm_auto_retrieve_timeout целое число	Максимальное время ожидания авто-извлечения.
fgfm_install_refresh_count целое число	Максимальное количество попыток обновления установки FGFM.
fgfm_sock_timeout целое число	Максимальное время простоя сокета FGFM.
fgfm_keepalive_itvl целое число	Интервал поддержания связи протокола FGFM.
force_remote_diff строка	Всегда использовать удалённое сравнение при установке. disable - Выключить. enable - Включить. Выбираемые значения: `"disable"` `"enable"`
fortiap_refresh_cnt целое число	Максимальное количество автоматических обновлений FortiAP каждый раз.
fortiap_refresh_itvl целое число	Интервал автоматического обновления статуса FortiAP.

fortiext-refresh-cnt integer	Устаревшее, пожалуйста, переименуйте его на fortiext_refresh_cnt. Максимальное количество устройств для автоматического обновления FortiExtender
install-fds-timeout integer	Устаревшее, пожалуйста, переименуйте его на install_fds_timeout. Максимальное время ожидания обновления fgt во время установки
install-image-timeout integer	Устаревшее, пожалуйста, переименуйте его на install_image_timeout. Максимальное время ожидания передачи изображения и обновления устройства
install-tunnel-retry-itvl integer	Устаревшее, пожалуйста, переименуйте его на install_tunnel_retry_itvl. Время повторного установления туннеля во время установки
log-autoupdate string	Устаревшее, пожалуйста, переименуйте его на log_autoupdate. Включить/выключить отладку регистрации автообновления. disable - Выключить. enable - Включить. Варианты: `"disable"` `"enable"`
max-revs integer	Устаревшее, пожалуйста, переименуйте его на max_revs. Максимальное количество сохранённых ревизий
nr-retry integer	Устаревшее, пожалуйста, переименуйте его на nr_retry. Количество попыток.
retry string	Включить/выключить повторную установку конфигурации. disable - Выключить. enable - Включить. Варианты: `"disable"` `"enable"`
retry-intvl integer	Устаревшее, пожалуйста, переименуйте его на retry_intvl. Интервал повтора.
rollback-allow-reboot string	Устаревшее, пожалуйста, переименуйте его на rollback_allow_reboot. Включить/выключить перезагрузку FortiGate для отката при установке скрипта/конфигурации. disable - Выключить. enable - Включить. Варианты: `"disable"` `"enable"`
script-logsize integer	Устаревшее, пожалуйста, переименуйте его на script_logsize. Максимальный размер журнала скрипта на устройство
skip-scep-check string	Устаревшее, пожалуйста, переименуйте его на skip_scep_check. Включить/выключить установку объектов, связанных с scep, даже если scep url настроен. disable - Выключить. enable - Включить. Варианты: `"disable"` `"enable"`
skip-tunnel-fcp-req string	Устаревшее, пожалуйста, переименуйте его на skip_tunnel_fcp_req. Включить/выключить пропуск запроса fcp, отправленного от fgfm туннеля disable - Выключить. enable - Включить. Варианты: `"disable"` `"enable"`
verify-install string	Устаревшее, пожалуйста, переименуйте его на verify_install. Проверка установки по отношению к удалённой конфигурации. disable - Выключить. optimal - Проверка установки на ошибки команд. enable - Всегда проверять установку. Варианты: `"disable"` `"optimal"` `"enable"`
workspace_locking_adom string	ADOM, который следует заблокировать для FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая 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_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure dm.
      fortinet.fortimanager.fmgr_system_dm:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        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>

Значения возврата

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

Ключ	Описание
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_dm_module.html