bigip_log_destination – Управляет пунктами назначения логов на BIG-IP
Новая в версии 2.6.
Краткое описание
- Управляет пунктами назначения логов на BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address строка добавлен в 2.8 | Указывает IP-адрес, который будет получать сообщения от указанного локального пункта назначения логов. Этот параметр доступен только когда type равен management-port. При создании нового пункта назначения логов и type равен management-port, этот параметр обязателен. | ||
| description строка | Описание пункта назначения логов. | ||
| distribution строка добавлен в 2.8 |
| Указывает метод распределения, используемый удалённым пунктом назначения логов высокой скорости для отправки сообщений членам пула. Когда adaptive, подключения к членам пула будут добавляться по мере необходимости для обеспечения достаточной пропускной способности логов. Это может иметь нежелательный эффект накопления логов только на одном члене пула, если он обеспечивает достаточную пропускную способность логов самостоятельно.Когда balanced, каждый последующий лог отправляется новому члену пула, балансируя логи между ними в соответствии с методом балансировки нагрузки пула.Когда replicated, каждый лог дублируется всем членам пула для обеспечения резервирования.При создании нового пункта назначения логов и type равен remote-high-speed-log, если этот параметр не указан, по умолчанию используется adaptive. | |
| forward_to строка добавлен в 2.8 | Когда type равен remote-syslog, указывает пункт назначения логов управления, который будет использоваться для переадресации логов на один сервер логов или удалённый пункт назначения логов высокой скорости, который будет использоваться для переадресации логов на пул удалённых серверов логов.Когда type равен splunk или arcsight, указывает пункт назначения логов, на который пересылаются логи. Этот пункт назначения логов может быть пунктом назначения порта управления, удалённым пунктом назначения логов высокой скорости или удалённым пунктом назначения Syslog, который настроен на отправку логов на сервер ArcSight или Splunk.При создании нового пункта назначения логов и type равен remote-syslog, splunk, или arcsight, этот параметр обязателен. | ||
| name строка / обязательно | Указывает имя пункта назначения логов. | ||
| partition строка | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| pool строка добавлен в 2.8 | Когда 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 целое число добавлен в 2.8 | Указывает порт IP-адреса, который будет получать сообщения от указанного локального пункта назначения логов. Этот параметр доступен только когда type равен management-port.При создании нового пункта назначения логов и type равен management-port, этот параметр обязателен. | ||
| protocol строка добавлен в 2.8 |
| Когда type равен remote-high-speed-log, указывает протокол, который система должна использовать для отправки логов в пул удалённых серверов логов высокой скорости, где хранятся логи.Когда type равен ipfix, может быть IPFIX или Netflow v9, в зависимости от типа коллекторов, которые у вас есть в пуле, который вы указали.Когда type равен management-port, указывает протокол, используемый для отправки сообщений в указанное место.Когда type равен management-port, только tcp и udp являются допустимыми значениями. | |
| provider словарь добавлен в 2.5 | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщик авторизации для получения маркеров аутентификации с удалённого устройства. Этот параметр используется при работе с устройствами BIG-IQ. | ||
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает SSH-ключевой файл для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль вернёт ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удалённому устройству. | |
| пользователь строка / обязательно | Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs булево |
| Если no, сертификаты SSL не проверяются. Используйте это только на сайтах, контролируемых вами, использующих самозаверяемые сертификаты.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
| server_ssl_profile строка добавлен в 2.8 | Если transport_profile является TCP-профилем, вы можете использовать это поле для выбора профиля Secure Socket Layer (SSL) для отправки логов в коллекторы IPFIX.Профиль сервера SSL определяет, как безопасно общаться по SSL или Transport Layer Security (TLS). Этот параметр доступен только при type равняется ipfix. | ||
| состояние строка |
| Когда present, гарантирует, что ресурс существует.Когда absent, гарантирует удаление ресурса. | |
| syslog_format строка добавлен в 2.8 |
| Указывает метод форматирования логов, связанных с удаленным местом назначения 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 целое число добавлен в 2.8 | Введите время (в секундах), которое устройство BIG-IP должно приостановить между удалением устаревшей шаблона IPFIX и повторным использованием его идентификатора шаблона. Эта функция полезна для систем, в которых вы используете iRules для создания настраиваемых шаблонов IPFIX. | ||
| template_retransmit_interval целое число добавлен в 2.8 | Введите время (в секундах) между каждой передачей шаблонов IPFIX в пул коллекторов IPFIX. Место назначения логов периодически пересылает все свои шаблоны IPFIX в заданном вами интервале в этом поле. Эти повторные передачи полезны для UDP, механизма передачи с потерями. Этот параметр доступен только при type равно ipfix. | ||
| transport_profile строка добавлен в 2.8 | Является профилем передачи, основанным на TCP или UDP. Этот профиль определяет параметры TCP или UDP, используемые для отправки логов IP-трафика в пул коллекторов. Этот параметр доступен только при type равно ipfix. | ||
| тип строка / обязательно |
| Указывает тип места назначения логов. После создания этот параметр изменить нельзя. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диске, включите хотя бы одну задачу, использующую модуль 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 строка | изменено | Новое значение поля Address. Пример: 1.2.3.2 |
| distribution строка | изменено | Новое значение метода Distribution. Пример: balanced |
| forward_to строка | изменено | Новое значение поля Forward To. Пример: /Common/dest1 |
| pool строка | изменено | Новое значение поля Pool. Пример: /Common/pool1 |
| port целое число | изменено | Новое значение поля Port. Пример: 2020 |
| protocol строка | изменено | Новое значение поля Protocol. Пример: tcp |
| server_ssl_profile строка | изменено | Новое значение профиля Server SSL. Пример: /Common/serverssl |
| syslog_format строка | изменено | Новое значение формата Syslog. Пример: syslog |
| template_delete_delay целое число | изменено | Новое значение задержки удаления шаблона. Пример: 20 |
| template_retransmit_interval целое число | изменено | Новое значение интервала повторной отправки шаблона. Пример: 200 |
| transport_profile строка | изменено | Новое значение профиля транспорта. Пример: /Common/tcp |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- 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.9/modules/bigip_log_destination_module.html
