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" | Раздел устройства для управления ресурсами. | |
| password строка / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| pool строка добавлен в 2.8 | Если type равно remote-high-speed-log, указывает существующий пул удаленных высокоскоростных серверов журналов, куда будут отправляться журналы.Если type равно ipfix, указывает существующий пул LTM удаленных коллекторов IPFIX. Любое приложение BIG-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 | Объект словаря, содержащий данные подключения. | ||
| 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 целое число | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. | |
| transport строка |
| Настраивает транспортное соединение для использования при подключении к удаленному устройству. | |
| пользователь строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логический |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| сервер строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число добавлен в 2.2 | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| 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. | ||
| тип строка / обязательно |
| Указывает тип пункта назначения журналов. После создания этот параметр изменить нельзя. | |
| пользователь строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логический добавлен в 2.0 |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самозаверяющими сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании 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 строка | изменённое | Новое значение адреса. Пример: 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 |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается партнёром 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.8/modules/bigip_log_destination_module.html
