Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_netflow – Настройка NetFlow в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать его в playbook, укажите: fortinet.fortios.fortios_system_netflow.

Добавлен в fortinet.fortios 2.0.0

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

Описание

  • Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять системные функции и категорию NetFlow. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

string

Токенная аутентификация. Создается в GUI Fortigate.

enable_log

boolean

Включить/Выключить логирование для задачи.

Варианты:

  • false ← (default)
  • true

member_path

string

Путь к атрибуту члена для выполнения операции.

Разделяется символом слеша, если атрибутов более одного.

Параметр, помеченный как member_path, является допустимым для выполнения операций с членами.

member_state

string

Добавить или удалить члена по указанному пути к атрибуту.

При указании member_state опция state игнорируется.

Варианты:

  • "present"
  • "absent"

system_netflow

dictionary

Настроить NetFlow.

active_flow_timeout

integer

Таймаут для отчета об активных потоках (60 - 3600 сек).

collector_ip

string

IP-адрес коллектора.

collector_port

integer

Номер порта коллектора NetFlow.

collectors

list / elements=dictionary

Коллекторы Netflow.

collector_ip

string

IP-адрес коллектора.

collector_port

integer

Номер порта коллектора NetFlow.

id

integer / required

ID. см. <a href=’#notes’>Примечания</a>.

interface

string

Укажите исходящий интерфейс для связи с сервером. Источник system.interface.name.

interface_select_method

string

Укажите способ выбора исходящего интерфейса для связи с сервером.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

source_ip

string

Исходящий IP-адрес для связи с агентом NetFlow.

inactive_flow_timeout

integer

Таймаут для периодического отчета о завершенных потоках (10 - 600 сек).

interface

string

Укажите исходящий интерфейс для связи с сервером. Источник system.interface.name.

interface_select_method

string

Укажите способ выбора исходящего интерфейса для связи с сервером.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

source_ip

string

Исходящий IP-адрес для связи с агентом NetFlow.

template_tx_counter

integer

Счетчик записей flowset перед повторной отправкой записи шаблона flowset.

template_tx_timeout

integer

Таймаут для периодической передачи набора шаблонов flowset (60 - 86400 сек).

vdom

string

Виртуальный домен, среди тех, которые были определены ранее. Vdom - это виртуальный экземпляр FortiGate, который может быть настроен и использоваться как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi был снят с поддержки, httpapi является предпочтительным способом запуска playbooks

Примеры

- name: Configure NetFlow.
  fortinet.fortios.fortios_system_netflow:
      vdom: "{{ vdom }}"
      system_netflow:
          active_flow_timeout: "1800"
          collector_ip: "<your_own_value>"
          collector_port: "2055"
          collectors:
              -
                  collector_ip: "<your_own_value>"
                  collector_port: "2055"
                  id: "9"
                  interface: "<your_own_value> (source system.interface.name)"
                  interface_select_method: "auto"
                  source_ip: "84.230.14.43"
          inactive_flow_timeout: "15"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          source_ip: "84.230.14.43"
          template_tx_counter: "20"
          template_tx_timeout: "1800"

Значения возврата

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

Ключ

Описание

build

строка

Номер сборки образа fortigate

Возвращается: всегда

Пример: "1547"

http_method

строка

Последний метод, используемый для подготовки контента в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

строка

Последний результат, предоставленный FortiGate после последней операции

Возвращается: всегда

Пример: "200"

mkey

строка

Главный ключ (id), используемый в последнем вызове FortiGate

Возвращается: успех

Пример: "id"

name

строка

Имя таблицы, используемой для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

строка

Путь к таблице, используемой для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

строка

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

строка

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

Возвращается: всегда

Пример: "success"

vdom

строка

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

строка

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекции

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (исходные коды)

© 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/fortios/fortios_system_netflow_module.html

Spec-Zone.ru

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