Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин является частью коллекции f5networks.f5_modules (версия 1.6.0).

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

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

Новое в версии 1.0.0: of f5networks.f5_modules

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

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

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
address
string
Указывает IP-адрес, который будет получать сообщения от указанного локального места назначения журнала.
Этот параметр доступен только тогда, когда type является management-port.
При создании нового места назначения журнала и type является management-port, этот параметр является обязательным.
description
string
Описание места назначения журнала.
distribution
string
    Варианты:
  • adaptive
  • balanced
  • replicated
Указывает метод распределения, используемый местом назначения журнала Remote High Speed для отправки сообщений участникам пула.
Когда adaptive, подключения к участникам пула будут добавляться по мере необходимости, чтобы обеспечить достаточную пропускную способность ведения журнала. Это может привести к нежелательному эффекту накопления журналов только на одном участнике пула, когда он обеспечивает достаточную пропускную способность ведения журнала самостоятельно.
Когда balanced, отправляет каждый последующий журнал новому участнику пула, балансируя журналы между ними в соответствии с методом балансировки нагрузки пула.
Когда replicated, реплицирует каждый журнал на всех участников пула для обеспечения избыточности.
При создании нового места назначения журнала и type является remote-high-speed-log, если этот параметр не указан, значение по умолчанию — adaptive.
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, этот параметр является обязательным.
pool_settings
dictionary
Этот параметр доступен только тогда, когда type является remote-high-speed-log.
Устарел. Используйте эквивалентные параметры верхнего уровня.
distribution
string
    Варианты:
  • adaptive
  • balanced
  • replicated
Указывает метод распределения, используемый местом назначения журнала Remote High Speed для отправки сообщений участникам пула.
Когда adaptive, подключения к участникам пула будут добавляться по мере необходимости, чтобы обеспечить достаточную пропускную способность ведения журнала. Это может привести к нежелательному эффекту накопления журналов только на одном участнике пула, когда он обеспечивает достаточную пропускную способность ведения журнала самостоятельно.
Когда balanced, отправляет каждый последующий журнал новому участнику пула, балансируя журналы между ними в соответствии с методом балансировки нагрузки пула.
Когда replicated, реплицирует каждый журнал на всех участников пула для обеспечения избыточности.
При создании нового места назначения журнала (и type является remote-high-speed-log), если этот параметр не указан, значение по умолчанию — adaptive.
pool
string
Указывает существующий пул удаленных высокоскоростных серверов журналов, куда будут отправляться журналы.
При создании нового места назначения (и type является remote-high-speed-log), этот параметр является обязательным.
protocol
string
    Варианты:
  • tcp
  • udp
Указывает протокол, который система будет использовать для отправки журналов в пул удаленных высокоскоростных серверов журналов, где хранятся журналы.
При создании нового места назначения журнала (и type является remote-high-speed-log), если этот параметр не указан, значение по умолчанию — tcp.
port
integer
Указывает порт IP-адреса, который будет получать сообщения от указанного локального места назначения журнала.
Этот параметр доступен только тогда, когда type является management-port.
При создании нового места назначения журнала и type является management-port, этот параметр является обязательным.
protocol
string
    Варианты:
  • tcp
  • udp
  • ipfix
  • netflow-9
Когда type является remote-high-speed-log, указывает протокол, который система будет использовать для отправки журналов в пул удаленных высокоскоростных серверов журналов, где хранятся журналы.
Когда type является ipfix, может быть IPFIX или Netflow v9, в зависимости от типа коллекторов, имеющихся в указанном вами пуле.
Когда type является management-port, указывает протокол, используемый для отправки сообщений в указанное место.
Когда type является management-port, допустимыми значениями являются только tcp и udp.
provider
dictionary
добавлено в версии 1.0.0 f5networks.f5_modules
Объект dict, содержащий сведения о подключении.
auth_provider
string
Настраивает поставщика проверки подлинности для получения маркеров проверки подлинности от удаленного устройства.
Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem
boolean
    Варианты:
  • no
  • yes
Если yes, данные телеметрии TEEM не отправляются в F5.
Вы можете пропустить этот параметр, установив переменную среды F5_TEEM.
password
string / required
Пароль для учетной записи пользователя, используемой для подключения к BIG-IP.
Вы можете пропустить этот параметр, установив переменную среды F5_PASSWORD.

алиасы: pass, pwd
server
string / required
Хост BIG-IP.
Вы можете пропустить этот параметр, установив переменную среды F5_SERVER.
server_port
integer
Значение по умолчанию:
443
Порт сервера BIG-IP.
Вы можете пропустить этот параметр, установив переменную среды F5_SERVER_PORT.
timeout
integer
Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку.
transport
string
    Варианты:
  • rest ←
Настраивает транспортное соединение, которое будет использоваться при подключении к удаленному устройству.
user
string / required
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве.
Вы можете пропустить этот параметр, установив переменную среды F5_USER.
validate_certs
boolean
    Варианты:
  • no
  • yes ←
Если no, SSL-сертификаты не проверяются. Используйте это только на лично контролируемых сайтах, использующих самозаверяющие сертификаты.
Вы можете пропустить этот параметр, установив переменную среды F5_VALIDATE_CERTS.
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, гарантирует существование ресурса.
Когда absent, гарантирует удаление ресурса.
syslog_format
string
    Choices:
  • bsd-syslog
  • syslog
  • legacy-bigip
  • rfc5424
  • rfc3164
Задает метод, используемый для форматирования журналов, связанных с удаленным целевым местом журнала Syslog.
При создании нового места назначения журнала (и type является remote-syslog), если этот параметр не указан, по умолчанию используется bsd-syslog.
Варианты syslog и rfc5424 совпадают.
Варианты bsd-syslog и rfc3164 совпадают.
syslog_settings
dictionary
Этот параметр доступен только тогда, когда type является remote-syslog.
Устарел. Используйте эквивалентные параметры верхнего уровня.
forward_to
string
Задает целевое место назначения журнала порта управления, которое будет использоваться для пересылки журналов на один сервер журналов или удаленное высокоскоростное целевое место назначения журнала, которое будет использоваться для пересылки журналов в пул удаленных серверов журналов.
При создании нового места назначения журнала (и type является remote-syslog), этот параметр обязателен.
syslog_format
string
    Choices:
  • bsd-syslog
  • syslog
  • legacy-bigip
  • rfc5424
  • rfc3164
Задает метод, используемый для форматирования журналов, связанных с удаленным целевым местом журнала Syslog.
При создании нового места назначения журнала (и type является remote-syslog), если этот параметр не указан, по умолчанию используется bsd-syslog.
Варианты syslog и rfc5424 совпадают.
Варианты bsd-syslog и 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
    Choices:
  • 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
changed
Новое значение профиля серверного SSL.

Пример:
/Common/serverssl
syslog_format
string
changed
Новое значение формата Syslog.

Пример:
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_log_destination_module.html

Spec-Zone.ru

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