bigip_log_destination - Управляет назначениями журналов на BIG-IP.
Новое в версии 2.6.
Описание
- Управляет назначениями журналов на BIG-IP.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| description | Описание назначения журнала. | ||
| name обязательно | Указывает имя назначения журнала. | ||
| partition | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, если переменная окружения F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| pool_settings | Этот параметр доступен только тогда, когда type равно remote-high-speed-log. | ||
| pool | Указывает существующий пул удаленных высокоскоростных серверов логов, куда будут отправлены журналы. При создании нового назначения (и type равно remote-high-speed-log) этот параметр обязателен. | ||
| protocol |
| Указывает протокол, используемый системой для отправки логов в пул удаленных высокоскоростных серверов логов. При создании нового назначения журнала (и type равно remote-high-speed-log), если этот параметр не указан, значение по умолчанию равно tcp. | |
| distribution |
| Указывает метод распределения, используемый удаленным высокоскоростным назначением логов для отправки сообщений членам пула. Когда adaptive, подключения к членам пула будут добавляться по мере необходимости для обеспечения достаточной пропускной способности логов. Это может привести к накоплению логов только на одном члене пула, если он обеспечивает достаточную пропускную способность логов самостоятельно.Когда balanced, каждый следующий лог отправляется новому члену пула, распределяя журналы между ними в соответствии с методом балансировки нагрузки пула.Когда replicated, каждый лог дублируется для всех членов пула, для обеспечения резервирования.При создании нового назначения журнала (и type равно remote-high-speed-log), если этот параметр не указан, значение по умолчанию равно adaptive. | |
| provider (добавлено в 2.5) | Объект словаря, содержащий данные о подключении. | ||
| password обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, если переменная окружения F5_PASSWORD установлена.Псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER установлена. | ||
| server_port | Значение по умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER_PORT установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, если переменная окружения F5_USER установлена. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами лично, с самозаверенными сертификатами. Этот параметр можно опустить, если переменная окружения F5_VALIDATE_CERTS установлена. | |
| timeout | Значение по умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | |
| ssh_keyfile | Указывает файл ключа SSH для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задании, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| server обязательно | Хост BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | Значение по умолчанию: 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER_PORT установлена. | |
| state |
| При present, гарантирует, что ресурс существует.При absent, гарантирует удаление ресурса. | |
| syslog_settings | Этот параметр доступен только тогда, когда type равно remote-syslog. | ||
| syslog_format |
| Указывает метод форматирования логов, связанных с удаленным назначением логов Syslog. При создании нового назначения журнала (и type равно remote-syslog), если этот параметр не указан, значение по умолчанию равно bsd-syslog.Варианты syslog и rfc5424 означают одно и то же.Варианты bsd-syslog и rfc3164 означают одно и то же. | |
| forward_to | Указывает назначение журнала управляющего порта, которое будет использоваться для переадресации журналов на один сервер логов или удаленное высокоскоростное назначение журнала, которое будет использоваться для переадресации журналов на пул удаленных серверов логов. При создании нового назначения журнала (и type равно remote-syslog) этот параметр обязателен. | ||
| type обязательно |
| Указывает тип назначения журнала. После создания этот параметр изменить нельзя. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, если переменная окружения F5_USER установлена. | ||
| validate_certs bool (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте только на сайтах, контролируемых вами лично, с самозаверенными сертификатами. Этот параметр можно опустить, если переменная окружения F5_VALIDATE_CERTS установлена. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Create a high-speed logging destination
bigip_log_destination:
name: foo
type: remote-high-speed-log
pool_settings:
pool: my-ltm-pool
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
- name: Create a remote-syslog logging destination
bigip_log_destination:
name: foo
type: remote-syslog
syslog_settings:
syslog_format: rfc5424
forward_to: my-destination
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
Возвращаемые значения
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| param1 bool | изменённое | Новое значение параметра param1 ресурса. Пример: True |
| param2 string | изменённое | Новое значение параметра param2 ресурса. Пример: Foo is bar |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом 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.6/modules/bigip_log_destination_module.html
