f5networks.f5_modules.bigip_log_destination – Управляет назначениями логов на BIG-IP.
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.
Чтобы использовать его в playbook, укажите: f5networks.f5_modules.bigip_log_destination.
Новое в версии 1.0.0: of f5networks.f5_modules
Описание
- Управляет назначениями логов на устройстве BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address строка | Указывает IP-адрес, который будет получать сообщения от указанного локального пункта назначения журнала. Этот параметр доступен только при type, равном management-port.При создании нового пункта назначения журнала и type, равном management-port, этот параметр является обязательным. | ||
| description строка | Описание пункта назначения журнала. | ||
| distribution строка |
| Указывает метод распределения, используемый пунктом назначения удаленного быстрого журнала для отправки сообщений членам пула. При adaptive, подключения к членам пула будут добавляться по мере необходимости для обеспечения достаточной пропускной способности для ведения журналов. Это может иметь нежелательный эффект, заключающийся в накоплении журналов только на одном члене пула, если он сам обеспечивает достаточную пропускную способность для ведения журналов.При balanced, каждый последующий журнал отправляется новому члену пула, распределяя журналы между ними в соответствии с методом балансировки нагрузки пула.При replicated, каждый журнал дублируется для всех членов пула, для обеспечения резервирования.При создании нового пункта назначения журнала и type, равном remote-high-speed-log, если этот параметр не указан, по умолчанию будет adaptive. | |
| forward_to строка | При type, равном remote-syslog, указывает пункт назначения журнала для управления портами, который будет использоваться для пересылки журналов на один сервер журналов или удаленный пункт назначения быстрого журнала, который будет использоваться для пересылки журналов в пул удаленных серверов журналов.При type, равном splunk, или arcsight, указывает пункт назначения журнала, на который пересылаются журналы. Этот пункт назначения может быть пунктом назначения порта управления, удаленным пунктом назначения быстрого журнала или удаленным пунктом назначения Syslog, настроенным на отправку журналов на сервер ArcSight или Splunk.При создании нового пункта назначения журнала и type, равном remote-syslog, splunk, или arcsight, этот параметр является обязательным. | ||
| name строка / обязательно | Указывает имя пункта назначения журнала. | ||
| partition строка | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| pool строка | При type, равном remote-high-speed-log, указывает существующий пул удаленных серверов быстрого журнала, куда будут отправляться журналы.При type, равном ipfix, указывает существующий пул LTM удаленных коллекторов IPFIX. Любое приложение BIG-IP, использующее этот пункт назначения журнала, отправляет свои журналы трафика IP в этот пул коллекторов.При создании нового пункта назначения и type, равном remote-high-speed-log, или ipfix, этот параметр является обязательным. | ||
| pool_settings словарь | Этот параметр доступен только при type, равном remote-high-speed-log.Устарел. Используйте эквивалентные параметры верхнего уровня вместо него. | ||
| distribution строка |
| Указывает метод распределения, используемый пунктом назначения удаленного быстрого журнала для отправки сообщений членам пула. При adaptive, подключения к членам пула будут добавляться по мере необходимости для обеспечения достаточной пропускной способности для ведения журналов. Это может иметь нежелательный эффект, заключающийся в накоплении журналов только на одном члене пула, если он сам обеспечивает достаточную пропускную способность для ведения журналов.При balanced, каждый последующий журнал отправляется новому члену пула, распределяя журналы между ними в соответствии с методом балансировки нагрузки пула.При replicated, каждый журнал дублируется для всех членов пула, для обеспечения резервирования.При создании нового пункта назначения журнала (и type, равном remote-high-speed-log), если этот параметр не указан, по умолчанию будет adaptive. | |
| pool строка | Указывает существующий пул удаленных серверов быстрого журнала, куда будут отправляться журналы. При создании нового пункта назначения (и type, равном remote-high-speed-log), этот параметр является обязательным. | ||
| protocol строка |
| Указывает протокол, используемый системой для отправки журналов в пул удаленных серверов быстрого журнала, где журналы хранятся. При создании нового пункта назначения журнала (и type, равном remote-high-speed-log), если этот параметр не указан, по умолчанию будет tcp. | |
| port целое число | Указывает порт IP-адреса, который будет получать сообщения от указанного локального пункта назначения журнала. Этот параметр доступен только при type, равном management-port.При создании нового пункта назначения журнала и type, равном management-port, этот параметр является обязательным. | ||
| protocol строка |
| При type, равном remote-high-speed-log, указывает протокол, используемый системой для отправки журналов в пул удаленных серверов быстрого журнала, где журналы хранятся.При type, равном ipfix, может быть IPFIX или Netflow v9, в зависимости от типа коллекторов, имеющихся в указанном пуле.При type, равном management-port, указывает протокол, используемый для отправки сообщений в указанное место.При type, равном management-port, допустимы только tcp, и udp. | |
| provider словарь добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения токенов аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem булево |
| Если yes, данные телеметрии TEEM не отправляются в F5.Вы можете опустить этот параметр, установив переменную среды F5_TEEM. | |
| password строка / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| timeout целое число | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истекает до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых вами лично, использующих самозаверенные сертификаты.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| server_ssl_profile строка | Если transport_profile — профиль TCP, вы можете использовать это поле для выбора профиля Secure Socket Layer (SSL) для отправки журналов в коллекторы IPFIX.Профиль сервера SSL определяет способ безопасной связи по SSL или Transport Layer Security (TLS). Этот параметр доступен только при type, равном ipfix. | ||
| state строка |
| При present, гарантирует существование ресурса.При absent, гарантирует удаление ресурса. | |
| syslog_format строка |
| Указывает метод форматирования логов, связанных с удаленным журналом Syslog. При создании нового источника логов (и type является remote-syslog), если этот параметр не указан, используется значение по умолчанию bsd-syslog.Варианты syslog и rfc5424 эквивалентны.Варианты bsd-syslog и rfc3164 эквивалентны. | |
| syslog_settings словарь | Этот параметр доступен только, когда type является remote-syslog.Устаревший. Используйте эквивалентные параметры верхнего уровня вместо него. | ||
| forward_to строка | Указывает целевой порт управления для перенаправления логов на один сервер или на удалённый высокоскоростной источник для перенаправления логов на пул удалённых серверов. При создании нового источника логов (и type является remote-syslog), этот параметр обязателен. | ||
| syslog_format строка |
| Указывает метод форматирования логов, связанных с удаленным журналом Syslog. При создании нового источника логов (и type является remote-syslog), если этот параметр не указан, используется значение по умолчанию bsd-syslog.Варианты syslog и rfc5424 эквивалентны.Варианты bsd-syslog и rfc3164 эквивалентны. | |
| template_delete_delay целое число | Укажите время (в секундах), которое устройство BIG-IP должно приостанавливать между удалением устаревшей шаблона IPFIX и повторным использованием его идентификатора шаблона. Эта функция полезна для систем, где вы используете iRules для создания настраиваемых шаблонов IPFIX. | ||
| template_retransmit_interval целое число | Укажите время (в секундах) между каждой передачей шаблонов IPFIX в пул коллекторов IPFIX. Источник логов периодически повторно передаёт все свои шаблоны IPFIX с интервалом, установленным в этом поле. Эти повторные передачи полезны для UDP, механизма транспорта с потерями. Этот параметр доступен только, когда type является ipfix. | ||
| transport_profile строка | Представляет собой профиль транспорта, основанный на TCP или UDP. Этот профиль определяет параметры TCP или UDP, используемые для отправки логов IP-трафика в пул коллекторов. Этот параметр доступен только, когда type является ipfix. | ||
| type строка / обязательно |
| Указывает тип источника логов. После создания этот параметр изменить нельзя. | |
Примечания
Примечание
- Дополнительную информацию об использовании 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 строка | изменено | Новое значение адреса. Пример: 1.2.3.2 |
| distribution строка | изменено | Новое значение метода распределения. Пример: balanced |
| forward_to строка | изменено | Новое значение Forward To. Пример: /Common/dest1 |
| pool строка | изменено | Новое значение пула. Пример: /Common/pool1 |
| port целое число | изменено | Новое значение порта. Пример: 2020 |
| protocol строка | изменено | Новое значение протокола. Пример: tcp |
| server_ssl_profile строка | изменено | Новое значение профиля SSL сервера. Пример: /Common/serverssl |
| syslog_format строка | изменено | Новое значение формата Syslog. Пример: syslog |
| template_delete_delay целое число | изменено | Новое значение задержки удаления шаблона. Пример: 20 |
| template_retransmit_interval целое число | изменено | Новое значение интервала повторной передачи шаблона. Пример: 200 |
| transport_profile строка | изменено | Новое значение профиля транспорта. Пример: /Common/tcp |
Авторы
- Tim Rupp (@caphrim007)
© 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/f5networks/f5_modules/bigip_log_destination_module.html
