Модуль fortinet.fortimanager.fmgr_dlp_dictionary — Настройка словарей, используемых блокировкой DLP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_dlp_dictionary.
Новая функция в fortinet.fortimanager 2.1.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager. Модуль продолжает выполнение без проверки параметров. Варианты:
|
dlp_dictionary словарь | Установленные параметры верхнего уровня. |
|
comment строка |
Дополнительные комментарии. |
|
entries список / элементы=словарь |
Элементы. |
|
comment строка |
Дополнительные комментарии. |
|
id целое число |
Идентификатор. |
|
ignore_case строка |
Устарело, пожалуйста, переименуйте на ignore_case. Включить/выключить игнорирование регистра. Варианты:
|
|
pattern строка |
Шаблон для соответствия. |
|
repeat строка |
Включить/выключить повторение совпадения. Варианты:
|
|
status строка |
Включить/выключить этот шаблон. Варианты:
|
|
type строка |
Тип шаблона для соответствия. |
|
fgd_id целое число |
Идентификатор объекта в базе данных FortiGuard. |
|
match_around строка |
Включить/выключить поддержку match-around. Варианты:
|
|
match_type строка |
Логическое отношение между записями. Варианты:
|
|
name строка / обязательно |
Имя таблицы, содержащей словарь. |
|
uuid строка |
Универсальный уникальный идентификатор |
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Проверка подлинности клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми условия для отказа будут переопределены. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия успешного выполнения. |
state строка / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | ADOM для блокировки в режиме работы с рабочей областью FortiManager. Значение может быть глобальным или другим, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. Значение по умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Configure dictionaries used by DLP blocking.
fortinet.fortimanager.fmgr_dlp_dictionary:
# 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>
state: present # <value in [present, absent]>
dlp_dictionary:
comment: <string>
entries:
-
comment: <string>
id: <integer>
ignore_case: <value in [disable, enable]>
pattern: <string>
repeat: <value in [disable, enable]>
status: <value in [disable, enable]>
type: <string>
match_type: <value in [match-all, match-any]>
name: <string>
uuid: <string>
match_around: <value in [disable, enable]>
fgd_id: <integer>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на коллекцию
© 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_dlp_dictionary_module.html
