модуль fortinet.fortimanager.fmgr_ips_baseline_sensor_override — переопределение базового датчика IPS

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation логический	Устанавливайте значение True только в случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логический	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.
ips_baseline_sensor_override словарь	Набор параметров верхнего уровня.
action строка	Действие правила переопределения. Варианты: `"pass"` `"block"` `"reset"`
exempt_ip псевдонимы: exempt-ip список / элементы=словарь	Исключаемый IP-адрес.
dst_ip псевдонимы: dst-ip строка	IP-адрес и маска подсети назначения.
id целое число	Идентификатор исключаемого IP-адреса.
src_ip псевдонимы: src-ip строка	IP-адрес и маска подсети источника.
log строка	Включить или отключить ведение журнала. Варианты: `"disable"` `"enable"`
log_packet псевдонимы: log-packet строка	Включить или отключить ведение журнала пакетов. Варианты: `"disable"` `"enable"`
quarantine строка	Помещение IP-адреса или интерфейса в карантин. Варианты: `"none"` `"attacker"` `"both"` `"interface"`
quarantine_expiry псевдонимы: quarantine-expiry целое число	Продолжительность карантина в минутах.
quarantine_log псевдонимы: quarantine-log строка	Включить или отключить ведение журнала для выбранного карантина. Варианты: `"disable"` `"enable"`
rule_id псевдонимы: rule-id целое число	Идентификатор правила переопределения.
status строка	Включить или отключить правило переопределения. Варианты: `"disable"` `"enable"`
proposed_method строка	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded список / элементы=целое число	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note строка	Примечание об изменении, которое можно указать при создании или обновлении объекта.
sensor строка / обязательный	Параметр (sensor) в запрашиваемом URL.
state строка / обязательный	Указание создать, обновить или удалить объект. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие значения, включая root.
workspace_locking_timeout целое число	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `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.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Ips baseline sensor override
      fortinet.fortimanager.fmgr_ips_baseline_sensor_override:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        sensor: <your own value>
        state: present # <value in [present, absent]>
        ips_baseline_sensor_override:
          # action: <value in [pass, block, reset]>
          # exempt_ip:
          #   - dst_ip: <string>
          #     id: <integer>
          #     src_ip: <string>
          # log: <value in [disable, enable]>
          # log_packet: <value in [disable, enable]>
          # quarantine: <value in [none, attacker, both, ...]>
          # quarantine_expiry: <integer>
          # quarantine_log: <value in [disable, enable]>
          # rule_id: <integer>
          # status: <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_ips_baseline_sensor_override_module.html