Spec-Zone.ru › Ansible

f5networks.f5_modules.bigip_log_destination модуль – Управляет целями регистрации на BIG-IP.

Примечание

Этот модуль является частью коллекции f5networks.f5_modules (версия 1.31.0).

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

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

Для использования в playbook, укажите: f5networks.f5_modules.bigip_log_destination.

Новое в f5networks.f5_modules 1.0.0

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

Краткое описание

  • Управляет целями регистрации на устройстве BIG-IP.

Параметры

Параметр

Комментарии

address

string

Указывает IP-адрес, который будет получать сообщения от указанного локального пункта назначения журнала.

Этот параметр доступен только тогда, когда type есть management-port.

При создании нового пункта назначения журнала и type есть management-port, этот параметр является обязательным.

description

string

Описание пункта назначения журнала.

distribution

string

Указывает метод распределения, используемый удаленным высокоскоростным пунктом назначения журнала для отправки сообщений участникам пула.

Когда adaptive, соединения с участниками пула будут добавляться по мере необходимости, чтобы обеспечить достаточную пропускную способность ведения журнала. Это может привести к нежелательному эффекту накопления журналов только на одном участнике пула, когда он обеспечивает достаточную пропускную способность ведения журнала самостоятельно.

Когда balanced, отправляет каждый последующий журнал новому участнику пула, распределяя журналы между ними в соответствии с методом балансировки нагрузки пула.

Когда replicated, реплицирует каждый журнал на всех участников пула для избыточности.

При создании нового пункта назначения журнала и type есть remote-high-speed-log, если этот параметр не указан, по умолчанию используется adaptive.

Варианты:

  • "adaptive"
  • "balanced"
  • "replicated"

forward_to

string

Когда type есть remote-syslog, указывает пункт назначения журнала управляющего порта, который будет использоваться для пересылки журналов на один сервер журналов или удаленный высокоскоростной пункт назначения журнала, который будет использоваться для пересылки журналов в пул удаленных серверов журналов.

Когда type есть splunk или arcsight, указывает пункт назначения журнала, на который пересылаются журналы. Этот пункт назначения журнала может быть пунктом назначения управляющего порта, удаленным высокоскоростным пунктом назначения журнала или удаленным пунктом назначения Syslog, который настроен на отправку журналов на сервер ArcSight или Splunk.

При создании нового пункта назначения журнала и type есть remote-syslog, splunk или arcsight, этот параметр является обязательным.

name

string / required

Указывает имя пункта назначения журнала.

partition

string

Раздел устройства для управления ресурсами.

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

pool

string

Когда type есть remote-high-speed-log, указывает существующий пул удаленных высокоскоростных серверов журналов, куда будут отправляться журналы.

Когда type есть ipfix, указывает существующий пул LTM удаленных коллекторов IPFIX. Любое приложение BIG-IP, использующее этот пункт назначения журнала, отправляет свои журналы IP-трафика в этот пул коллекторов.

При создании нового пункта назначения и type есть remote-high-speed-log или ipfix, этот параметр является обязательным.

port

integer

Указывает порт IP-адреса, который будет получать сообщения от указанного локального пункта назначения журнала.

Этот параметр доступен только тогда, когда type есть management-port.

При создании нового пункта назначения журнала и type есть management-port, этот параметр является обязательным.

protocol

string

Когда type есть remote-high-speed-log, указывает протокол, который система будет использовать для отправки журналов в пул удаленных высокоскоростных серверов журналов, где хранятся журналы.

Когда type есть ipfix, может быть IPFIX или Netflow v9, в зависимости от типа коллекторов, которые у вас есть в указанном пуле.

Когда type есть management-port, указывает протокол, используемый для отправки сообщений в указанное местоположение.

Когда type есть management-port, допустимы только значения tcp и udp.

Варианты:

  • "tcp"
  • "udp"
  • "ipfix"
  • "netflow-9"

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

Объект dict, содержащий сведения о подключении.

auth_provider

string

Настраивает поставщика проверки подлинности для получения маркеров проверки подлинности от удаленного устройства.

Этот параметр действительно используется при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если yes, данные телеметрии TEEM не отправляются в F5.

Вы можете пропустить этот параметр, установив переменную среды F5_TELEMETRY_OFF.

Прежде используемая переменная F5_TEEM устарела, так как ее имя было запутанным.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

string / required

Пароль для учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Вы можете пропустить этот параметр, установив переменную среды F5_PASSWORD.

server

string / required

Хост BIG-IP или хост BIG-IQ.

Вы можете пропустить этот параметр, установив переменную среды F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Вы можете пропустить этот параметр, установив переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

Задает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.

transport

string

Настраивает транспортное соединение, используемое при подключении к удаленному устройству.

Варианты:

  • "rest" ← (default)

user

string / required

Имя пользователя для подключения к BIG-IP или BIG-IQ. Этот пользователь должен иметь административные права на устройстве.

Вы можете пропустить этот параметр, установив переменную среды F5_USER.

validate_certs

boolean

Если no, SSL-сертификаты не проверяются. Используйте это только на лично контролируемых сайтах, использующих самозаверенные сертификаты.

Вы можете пропустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (default)

server_ssl_profile

string

Если transport_profile является TCP-профилем, вы можете использовать это поле для выбора профиля Secure Socket Layer (SSL) для отправки журналов в коллекторы IPFIX.

Серверный SSL-профиль определяет, как безопасно обмениваться данными по SSL или Transport Layer Security (TLS).

Этот параметр доступен только тогда, когда type равно ipfix.

state

string

Когда present, гарантирует существование ресурса.

Когда absent, гарантирует удаление ресурса.

Варианты:

  • "present" ← (default)
  • "absent"

syslog_format

string

Указывает метод, используемый для форматирования журналов, связанных с удаленным целевым местом журнала Syslog.

При создании нового целевого места журнала (и type равно remote-syslog), если этот параметр не указан, значение по умолчанию равно bsd-syslog.

Варианты syslog и rfc5424 идентичны.

Варианты bsd-syslog и rfc3164 идентичны.

Варианты:

  • "bsd-syslog"
  • "syslog"
  • "legacy-bigip"
  • "rfc5424"
  • "rfc3164"

template_delete_delay

integer

Введите время (в секундах), которое устройство BIG-IP должно приостановить между удалением устаревшего шаблона IPFIX и повторным использованием его идентификатора шаблона.

Эта функция полезна для систем, в которых вы используете iRules для создания настраиваемых шаблонов IPFIX.

template_retransmit_interval

integer

Введите время (в секундах) между каждой передачей шаблонов IPFIX в пул коллекторов IPFIX.

Целевое местоположение ведения журнала периодически повторно передает все свои шаблоны IPFIX с интервалом, указанным в этом поле. Эти повторные передачи полезны для UDP, ненадежного транспортного механизма.

Этот параметр доступен только тогда, когда type равно ipfix.

transport_profile

string

Является транспортным профилем на основе TCP или UDP.

Этот профиль определяет параметры TCP или UDP, используемые для отправки журналов IP-трафика в пул коллекторов.

Этот параметр доступен только тогда, когда type равно ipfix.

type

string / required

Указывает тип целевого места журнала.

После создания этот параметр изменить нельзя.

Варианты:

  • "remote-high-speed-log"
  • "remote-syslog"
  • "arcsight"
  • "splunk"
  • "management-port"
  • "ipfix"

Примечания

Примечание

  • Дополнительная информация об использовании Ansible для управления устройствами F5 Networks см. по адресу https://www.ansible.com/integrations/networks/f5.
  • Требуется версия программного обеспечения BIG-IP >= 12.
  • Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы гарантировать сохранение специфической для BIG-IP конфигурации на диске, обязательно включите хотя бы одну задачу, которая использует модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create a high-speed logging destination
  bigip_log_destination:
    name: foo
    type: remote-high-speed-log
    pool: my-ltm-pool
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Create a remote-syslog logging destination
  bigip_log_destination:
    name: foo
    type: remote-syslog
    syslog_format: rfc5424
    forward_to: my-destination
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ

Описание

address

string

Новое значение адреса.

Возвращено: changed

Пример: "1.2.3.2"

distribution

string

Новое значение метода распределения.

Возвращено: changed

Пример: "balanced"

forward_to

string

Новое значение переадресации.

Возвращено: changed

Пример: "/Common/dest1"

pool

string

Новое значение пула.

Возвращено: changed

Пример: "/Common/pool1"

port

integer

Новое значение порта.

Возвращено: changed

Пример: 2020

protocol

string

Новое значение протокола.

Возвращено: changed

Пример: "tcp"

server_ssl_profile

string

Новое значение профиля серверного SSL.

Возвращено: changed

Пример: "/Common/serverssl"

syslog_format

string

Новое значение формата Syslog.

Возвращено: changed

Пример: "syslog"

template_delete_delay

integer

Новое значение задержки удаления шаблона.

Возвращено: changed

Пример: 20

template_retransmit_interval

integer

Новое значение интервала повторной передачи шаблона.

Возвращено: changed

Пример: 200

transport_profile

string

Новое значение транспортного профиля.

Возвращено: changed

Пример: "/Common/tcp"

Авторы

  • Tim Rupp (@caphrim007)

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

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

© 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/f5networks/f5_modules/bigip_log_destination_module.html

Spec-Zone.ru

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