Модуль fortinet.fortimanager.fmgr_system_sql_customskipidx — Список дополнительных полей SQL-индексов пропуска.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_system_sql_customskipidx.
Добавлен в fortinet.fortimanager 2.1.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_customskipidx словарь | Настройка параметров верхнего уровня. |
|
device_type строка |
Устарело, пожалуйста, переименуйте его в device_type. Тип устройства. FortiGate — Установите тип устройства на FortiGate. FortiManager — Установите тип устройства на FortiManager FortiClient — Установите тип устройства на FortiClient. FortiMail — Установите тип устройства на FortiMail. FortiWeb — Установите тип устройства на FortiWeb. FortiSandbox — Установите тип устройства на FortiSandbox FortiProxy — Установите тип устройства на FortiProxy Варианты:
|
|
id целое число / обязательно |
Добавление или редактирование полей индекса логов. |
|
index_field строка |
Устарело, пожалуйста, переименуйте его в index_field. Поле, которое нужно добавить в индекс пропуска. |
|
log_type строка |
Устарело, пожалуйста, переименуйте его в log_type. Тип лога. 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 file-filter asset Варианты:
|
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: List of aditional SQL skip index fields.
fortinet.fortimanager.fmgr_system_sql_customskipidx:
# 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, ...]
state: present # <value in [present, absent]>
system_sql_customskipidx:
device_type: <value in [FortiGate, FortiManager, FortiClient, ...]>
id: <integer>
index_field: <string>
log_type: <value in [app-ctrl, attack, content, ...]>
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
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_customskipidx_module.html
