Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_remote_syslog — управление настройками удалённого системного журнала на BIG-IP

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

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

Чтобы использовать коллекцию в плейбуке, укажите: f5networks.f5_modules.bigip_remote_syslog.

Добавлено в f5networks.f5_modules 1.0.0

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

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

  • Управление настройками удалённого системного журнала на системе BIG-IP.

Параметры

Параметр

Комментарии

local_ip

string

Указывает локальный IP-адрес системы, которая ведёт журнал. Чтобы не указывать локальный IP-адрес, задайте значение none.

При создании удалённого системного журнала, если этот параметр не указан, используется значение по умолчанию none.

name

string

Указывает имя объекта syslog.

Этот параметр обязателен, если на устройстве присутствует несколько remote_host с одинаковым IP-адресом или именем хоста.

Если name не указан, по умолчанию используется remote_host.

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

Словарь с данными для подключения.

auth_provider

string

Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства.

Этот параметр используется при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если задано значение yes, телеметрические данные TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную среды F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM устарела, поскольку её название вводило в заблуждение.

Варианты:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

string / обязательный

Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_PASSWORD.

server

string / обязательный

Имя хоста BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную среды F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную среды F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

Задаёт время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если до завершения операции время ожидания истечёт, модуль вернёт ошибку.

transport

string

Настраивает транспортное соединение, используемое при подключении к удалённому устройству.

Варианты:

  • "rest" ← (по умолчанию)

user

string / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве.

Этот параметр можно не указывать, задав переменную среды F5_USER.

validate_certs

boolean

Если задано значение no, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах под вашим контролем, использующих самоподписанные сертификаты.

Этот параметр можно не указывать, задав переменную среды F5_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

remote_host

string / обязательный

Указывает IP-адрес или имя хоста удалённой системы, на которую система отправляет сообщения журнала.

remote_port

string

Указывает порт, используемый системой для отправки сообщений на удалённый сервер журналирования.

При создании удалённого системного журнала, если этот параметр не указан, используется значение по умолчанию 514.

state

string

Если задано значение present, гарантирует наличие удалённого системного журнала с указанными атрибутами.

Если задано значение absent, удаляет удалённый системный журнал из системы.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

Примечания

Примечание

  • Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется версия программного обеспечения BIG-IP >= 12.
  • Модули F5 изменяют только работающую конфигурацию продукта F5. Чтобы сохранить конфигурацию BIG-IP на диске, обязательно добавьте хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения работающей конфигурации. Инструкции по правильному использованию модуля для сохранения работающей конфигурации см. в документации модуля.

Примеры

- name: Add a remote syslog server to log to
  bigip_remote_syslog:
    remote_host: 10.10.10.10
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Add a remote syslog server on a non-standard port to log to
  bigip_remote_syslog:
    remote_host: 10.10.10.10
    remote_port: 1234
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

local_ip

string

Новый локальный IP-адрес сервера удалённого системного журнала.

Возвращается: changed

Пример: "10.10.10.10"

remote_port

integer

Новый удалённый порт сервера удалённого системного журнала.

Возвращается: changed

Пример: 514

Авторы

  • Tim Rupp (@caphrim007)
  • Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_remote_syslog_module.html

Spec-Zone.ru

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