fortinet.fortimanager.fmgr_ips_baseline_sensor_override модуль – Настройка отключения датчика базовых значений IPS

Примечание

Этот модуль входит в состав коллекции fortinet.fortimanager (версия 2.7.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 целое число	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. ID правила переопределения.
status строка	Включить/выключить состояние правила переопределения. Варианты: `"disable"` `"enable"`
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены.

END_OF_DOCUMENT_MARKER

rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут считаться выполненными.
sensor строка / обязательно	Параметр (датчик) в запрошенном URL.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки в режиме работы FortiManager в пространстве рабочей области; значение может быть глобальным и другими, включая корневой.
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 помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться неудачей при возвращении ненулевого rc. Вы также можете переопределить условия для неудачи или успеха с параметрами 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: Ips baseline sensor override
      fortinet.fortimanager.fmgr_ips_baseline_sensor_override:
        # 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, ...]
        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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_ips_baseline_sensor_override_module.html