Модуль fortinet.fortimanager.fmgr_system_sql_customindex – Список полей SQL-индексов.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_sql_customindex.
Добавлена в fortinet.fortimanager 2.0.0
Описание
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать для использования с источниками данных.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation логический | Устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров. Варианты:
|
enable_log логический | Включение/выключение ведения журнала для задачи. Варианты:
|
forticloud_access_token строка | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method строка | Переопределенный метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для сбоя. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для успеха. |
state строка / обязательно | Направление для создания, обновления или удаления объекта. Варианты:
|
system_sql_customindex словарь | Набор параметров верхнего уровня. |
|
case_sensitive строка |
Устарело, пожалуйста, переименуйте его в case_sensitive. Отключение/включение регистрозависимого индекса. disable - Создать регистронезависимый индекс. enable - Создать регистрозависимый индекс. Варианты:
|
|
device_type строка |
Устарело, пожалуйста, переименуйте его в device_type. Тип устройства. FortiGate - Тип устройства FortiGate. FortiManager - Установить тип устройства на FortiManager FortiClient - Установить тип устройства на FortiClient FortiMail - Тип устройства FortiMail. FortiWeb - Тип устройства FortiWeb. FortiCache - Установить тип устройства на FortiCache FortiSandbox - Установить тип устройства на FortiSandbox FortiDDoS - Установить тип устройства на FortiDDoS FortiAuthenticator - Установить тип устройства на FortiAuthenticator FortiProxy - Установить тип устройства на FortiProxy Варианты:
|
|
id целое число / обязательно |
Добавление или редактирование полей индекса журнала. |
|
index_field строка |
Устарело, пожалуйста, переименуйте его в index_field. Имя поля журнала для индексирования. |
|
log_type строка |
Устарело, пожалуйста, переименуйте его в log_type. Тип журнала. none - none app-ctrl attack content dlp emailfilter event generic history traffic virus voip webfilter netscan fct-event fct-traffic fct-netscan waf gtp dns ssh ssl Варианты:
|
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
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: List of SQL index fields.
fortinet.fortimanager.fmgr_system_sql_customindex:
bypass_validation: false
state: present
system_sql_customindex:
case-sensitive: disable
device-type: FortiGate # <value in [FortiGate, FortiManager, FortiClient, ...]>
id: 1
index-field: srcip
log-type: attack # <value in [none, app-ctrl, attack, ...]>
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the SQL index fields
fortinet.fortimanager.fmgr_fact:
facts:
selector: "system_sql_customindex"
params:
custom-index: "your_value"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
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_system_sql_customindex_module.html
