Модуль fortinet.fortimanager.fmgr_system_log_deviceselector — принятие или отклонение устройств, соответствующих указанным типам фильтров.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_log_deviceselector.
Новое в fortinet.fortimanager 2.10.0
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
state string / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
system_log_deviceselector dictionary | Набор параметров верхнего уровня. |
|
action string |
Включить или исключить соответствующие устройства. include — включить устройства, соответствующие указанному типу фильтра. exclude — исключить устройства, соответствующие указанному типу фильтра. Варианты:
|
|
comment string |
Дополнительный комментарий к селектору. |
|
devid string |
Идентификатор устройства. |
|
expire string |
Время истечения срока действия селектора. |
|
id integer / обязательный |
Идентификатор записи селектора устройств. |
|
srcip string |
IP-адрес источника или диапазон IP-адресов. |
|
srcip_mode псевдонимы: srcip-mode string |
Применить селектор к UDP/514, TCP/514 или ко всем режимам. UDP514 — клиенты, выполняющие ведение журнала через порт UDP 514. TCP514 — клиенты, выполняющие ведение журнала через порт TCP 514. any — клиенты, выполняющие ведение журнала в любом режиме. Варианты:
|
|
type string |
Тип селектора. unspecified — тип фильтра не указан. devid — фильтровать устройства по DeviceID. srcip — фильтровать устройства по IP-адресу источника. Варианты:
|
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Accept/reject devices matching specified filter types.
fortinet.fortimanager.fmgr_system_log_deviceselector:
# workspace_locking_adom: <global or your adom name>
state: present # <value in [present, absent]>
system_log_deviceselector:
id: 0 # Required variable, integer
# action: <value in [include, exclude]>
# comment: <string>
# devid: <string>
# expire: <string>
# srcip: <string>
# srcip_mode: <value in [UDP514, TCP514, any]>
# type: <value in [unspecified, devid, srcip]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса к API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при соответствующих условиях |
Ссылки на коллекцию
© 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_system_log_deviceselector_module.html
