Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_fmupdate_fgdsetting — настройка CLI fmupdate fgd

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

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

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

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

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

Параметры

Параметр

Комментарии

access_token

string

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

bypass_validation

boolean

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

Варианты:

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

enable_log

boolean

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

Варианты:

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

fmupdate_fgdsetting

dictionary

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

as_cache

aliases: as-cache

integer

Кэш AS.

as_log

aliases: as-log

string

Журнал AS.

Варианты:

  • "disable"
  • "nospam"
  • "all"

as_preload

aliases: as-preload

string

Предварительная загрузка AS.

Варианты:

  • "disable"
  • "enable"

av2_cache

aliases: av2-cache

integer

Кэш AV2.

av2_log

aliases: av2-log

string

Журнал AV2.

Варианты:

  • "disable"
  • "noav2"
  • "all"

av2_preload

aliases: av2-preload

string

Предварительная загрузка AV2.

Варианты:

  • "disable"
  • "enable"

av_cache

aliases: av-cache

integer

Кэш AV.

av_log

aliases: av-log

string

Журнал AV.

Варианты:

  • "disable"
  • "novirus"
  • "all"

av_preload

aliases: av-preload

string

Предварительная загрузка AV.

Варианты:

  • "disable"
  • "enable"

eventlog_query

aliases: eventlog-query

string

Запрос журнала событий.

Варианты:

  • "disable"
  • "enable"

fgd_pull_interval

aliases: fgd-pull-interval

integer

Интервал получения FGD.

fq_cache

aliases: fq-cache

integer

Кэш FQ.

fq_log

aliases: fq-log

string

Журнал FQ.

Варианты:

  • "disable"
  • "nofilequery"
  • "all"

fq_preload

aliases: fq-preload

string

Предварительная загрузка FQ.

Варианты:

  • "disable"
  • "enable"

iot_cache

aliases: iot-cache

integer

Кэш IoT.

iot_log

aliases: iot-log

string

Журнал IoT.

Варианты:

  • "disable"
  • "noiot"
  • "all"

iot_preload

aliases: iot-preload

string

Предварительная загрузка IoT.

Варианты:

  • "disable"
  • "enable"

iotv_preload

aliases: iotv-preload

string

Предварительная загрузка IoTV.

Варианты:

  • "disable"
  • "enable"

linkd_log

aliases: linkd-log

string

Журнал Linkd.

Варианты:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warn"
  • "notice"
  • "info"
  • "debug"
  • "disable"

max_client_worker

aliases: max-client-worker

integer

Максимальное количество рабочих процессов клиента.

max_log_quota

aliases: max-log-quota

integer

Максимальная квота журнала.

max_unrated_site

aliases: max-unrated-site

integer

Максимальное количество сайтов без рейтинга.

restrict_as1_dbver

aliases: restrict-as1-dbver

string

Ограничить версию базы данных AS1.

restrict_as2_dbver

aliases: restrict-as2-dbver

string

Ограничить версию базы данных AS2.

restrict_as4_dbver

aliases: restrict-as4-dbver

string

Ограничить версию базы данных AS4.

restrict_av2_dbver

aliases: restrict-av2-dbver

string

Ограничить версию базы данных AV2.

restrict_av_dbver

aliases: restrict-av-dbver

string

Ограничить версию базы данных AV.

restrict_fq_dbver

aliases: restrict-fq-dbver

string

Ограничить версию базы данных FQ.

restrict_iots_dbver

aliases: restrict-iots-dbver

string

Ограничить версию базы данных IOTS.

restrict_wf_dbver

aliases: restrict-wf-dbver

string

Ограничить версию базы данных WF.

server_override

aliases: server-override

dictionary

Переопределение сервера.

servlist

list / elements=dictionary

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

id

integer

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

ip

string

IP-адрес.

ip6

string

IPv6-адрес.

port

integer

Порт.

service_type

aliases: service-type

string

Тип службы.

Варианты:

  • "fgd"
  • "fsa"
  • "fgfq"
  • "geoip"
  • "iot-collect"

status

string

Статус.

Варианты:

  • "disable"
  • "enable"

stat_log

aliases: stat-log

string

Журнал статистики.

Варианты:

  • "emergency"
  • "alert"
  • "critical"
  • "error"
  • "warn"
  • "notice"
  • "info"
  • "debug"
  • "disable"

stat_log_interval

aliases: stat-log-interval

integer

Интервал ведения журнала статистики.

stat_sync_interval

aliases: stat-sync-interval

integer

Интервал синхронизации статистики.

update_interval

aliases: update-interval

integer

Интервал обновления.

update_log

aliases: update-log

string

Журнал обновлений.

Варианты:

  • "disable"
  • "enable"

wf_cache

aliases: wf-cache

integer

Кэш WF.

wf_dn_cache_expire_time

aliases: wf-dn-cache-expire-time

integer

Время истечения срока действия кэша доменных имен WF.

wf_dn_cache_max_number

aliases: wf-dn-cache-max-number

integer

Максимальное количество записей в кэше доменных имен WF.

wf_log

aliases: wf-log

string

Журнал WF.

Варианты:

  • "disable"
  • "nourl"
  • "all"

wf_preload

aliases: wf-preload

string

Предварительная загрузка WF.

Варианты:

  • "disable"
  • "enable"

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: Cli fmupdate fgd setting
      fortinet.fortimanager.fmgr_fmupdate_fgdsetting:
        # workspace_locking_adom: <global or your adom name>
        fmupdate_fgdsetting:
          # as_cache: <integer>
          # as_log: <value in [disable, nospam, all]>
          # as_preload: <value in [disable, enable]>
          # av_cache: <integer>
          # av_log: <value in [disable, novirus, all]>
          # av_preload: <value in [disable, enable]>
          # av2_cache: <integer>
          # av2_log: <value in [disable, noav2, all]>
          # av2_preload: <value in [disable, enable]>
          # eventlog_query: <value in [disable, enable]>
          # fgd_pull_interval: <integer>
          # fq_cache: <integer>
          # fq_log: <value in [disable, nofilequery, all]>
          # fq_preload: <value in [disable, enable]>
          # iot_cache: <integer>
          # iot_log: <value in [disable, noiot, all]>
          # iot_preload: <value in [disable, enable]>
          # iotv_preload: <value in [disable, enable]>
          # linkd_log: <value in [emergency, alert, critical, ...]>
          # max_client_worker: <integer>
          # max_log_quota: <integer>
          # max_unrated_site: <integer>
          # restrict_as1_dbver: <string>
          # restrict_as2_dbver: <string>
          # restrict_as4_dbver: <string>
          # restrict_av_dbver: <string>
          # restrict_av2_dbver: <string>
          # restrict_fq_dbver: <string>
          # restrict_iots_dbver: <string>
          # restrict_wf_dbver: <string>
          # server_override:
          #   servlist:
          #     - id: <integer>
          #       ip: <string>
          #       ip6: <string>
          #       port: <integer>
          #       service_type: <value in [fgd, fsa, fgfq, ...]>
          #   status: <value in [disable, enable]>
          # stat_log: <value in [emergency, alert, critical, ...]>
          # stat_log_interval: <integer>
          # stat_sync_interval: <integer>
          # update_interval: <integer>
          # update_log: <value in [disable, enable]>
          # wf_cache: <integer>
          # wf_dn_cache_expire_time: <integer>
          # wf_dn_cache_max_number: <integer>
          # wf_log: <value in [disable, nourl, all]>
          # wf_preload: <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_fmupdate_fgdsetting_module.html

Spec-Zone.ru

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