Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_ips_custom – Настройка пользовательской подписи IPS.

Примечание

Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_ips_custom.

Новое в версии 2.10: модуля fortinet.fortimanager

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Этот модуль позволяет настроить устройство FortiManager.
  • Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adom
строка / обязательно
параметр (adom) в запрошенном URL
bypass_validation
логическое значение
    Варианты:
  • нет ←
  • да
устанавливается в значение True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без проверки параметров
ips_custom
словарь
настраиваемые параметры верхнего уровня
action
строка
    Варианты:
  • block
  • pass
Действие по умолчанию (pass или block) для этой подписи.
application
строка
нет описания
comment
строка
Комментарий.
location
строка
нет описания
log
строка
    Варианты:
  • отключить
  • включить
Включить/выключить логирование.
log-packet
строка
    Варианты:
  • отключить
  • включить
Включить/выключить логирование пакетов.
os
строка
нет описания
protocol
строка
Протокол(ы), которые сканирует подпись. Пустая строка — для всех протоколов.
rule-id
целое число
нет описания
severity
строка
Относительная серьезность подписи, от info до critical. Сообщения журнала, генерируемые подписью, включают серьезность.
sig-name
строка
нет описания
signature
строка
Пользовательская подпись в одинарных кавычках.
status
строка
    Варианты:
  • отключить
  • включить
Включить/выключить эту подпись.
tag
строка
Тег подписи.
rc_failed
список / элементы=строка
Список кодов rc, при которых условия будут считаться выполненными
rc_succeeded
список / элементы=строка
Список кодов rc, при которых условия будут считаться выполненными
state
строка / обязательно
    Варианты:
  • present
  • absent
Директива для создания, обновления или удаления объекта
workspace_locking_adom
строка
Область для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая root
workspace_locking_timeout
целое число
По умолчанию:
300
Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

  • Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно запуск одного модуля может завершиться неудачей, когда возвращается ненулевой rc. Также вы можете переопределить условия для неудачи или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPS custom signature.
     fmgr_ips_custom:
        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: <value in [present, absent]>
        ips_custom:
           action: <value in [block, pass]>
           application: <value of string>
           comment: <value of string>
           location: <value of string>
           log: <value in [disable, enable]>
           log-packet: <value in [disable, enable]>
           os: <value of string>
           protocol: <value of string>
           rule-id: <value of integer>
           severity: <value of string>
           sig-name: <value of string>
           signature: <value of string>
           status: <value in [disable, enable]>
           tag: <value of string>

Возвращаемые значения

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ Возвращаемое значение Описание
request_url
строка
всегда
Полный запрошенный URL

Пример:
/sys/login/user
response_code
целое число
всегда
Статус запроса API

response_message
строка
всегда
Дескриптивное сообщение ответа API

Пример:
OK.


Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_ips_custom_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API