dellemc.openmanage.ome_application_alerts_syslog module — настройка параметров переадресации syslog в OpenManage Enterprise и OpenManage Enterprise Modular

Примечание

Этот модуль входит в коллекцию dellemc.openmanage (версия 10.0.2).

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

Для установки используйте: ansible-galaxy collection install dellemc.openmanage. Для работы с этим модулем также необходимы дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: dellemc.openmanage.ome_application_alerts_syslog.

Добавлено в dellemc.openmanage 4.3.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настроить параметры переадресации syslog в OpenManage Enterprise и OpenManage Enterprise Modular.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.9.6

Параметры

Параметр	Комментарии
ca_path путь добавлено в dellemc.openmanage 5.0.0	Файл Privacy Enhanced Mail (PEM), содержащий сертификат центра сертификации, который будет использоваться для проверки.
hostname строка / обязательный	IP-адрес или имя узла OpenManage Enterprise либо OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_PASSWORD=password
port целое число	Порт HTTPS OpenManage Enterprise или OpenManage Enterprise Modular. По умолчанию: `443`
syslog_servers список / элементы=словарь	Список серверов для переадресации syslog.
destination_address строка	IP-адрес, FQDN или имя узла сервера syslog. Обязательный параметр, если enabled имеет значение `true`.
enabled логическое значение	Включение или отключение переадресации syslog. Варианты: `false` `true`
id целое число / обязательный	Идентификатор сервера syslog. Варианты: `1` `2` `3` `4`
port_number целое число	Номер порта UDP сервера syslog.
timeout целое число добавлено в dellemc.openmanage 5.0.0	Тайм-аут на уровне сокета в секундах. По умолчанию: `30`
username строка	Имя пользователя OpenManage Enterprise или OpenManage Enterprise Modular. Если имя пользователя не указано, используется переменная среды `OME_USERNAME`. Пример: export OME_USERNAME=username
validate_certs логическое значение добавлено в dellemc.openmanage 5.0.0	Если `false`, проверка SSL-сертификатов выполняться не будет. Настраивайте `false` только на контролируемых вами ресурсах, где используются самоподписанные сертификаты. До версии коллекции `5.0.0` параметр validate_certs по умолчанию имеет значение `false`. Варианты: `false` `true` ← (по умолчанию)
x_auth_token строка добавлено в dellemc.openmanage 9.3.0	Токен аутентификации. Если x_auth_token не указан, используется переменная среды `OME_X_AUTH_TOKEN`. Пример: export OME_X_AUTH_TOKEN=x_auth_token

Примечания

Примечание

Запускайте этот модуль в системе, имеющей прямой доступ к Dell OpenManage Enterprise или Dell OpenManage Enterprise Modular.
Этот модуль поддерживает check_mode.

Примеры

---
- name: Configure single server to forward syslog
  dellemc.openmanage.ome_application_alerts_syslog:
    hostname: 192.168.0.1
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    syslog_servers:
      - id: 1
        enabled: true
        destination_address: 192.168.0.2
        port_number: 514

- name: Configure multiple server to forward syslog
  dellemc.openmanage.ome_application_alerts_syslog:
    hostname: 192.168.0.1
    username: "username"
    password: "password"
    ca_path: "/path/to/ca_cert.pem"
    syslog_servers:
      - id: 1
        port_number: 523
      - id: 2
        enabled: true
        destination_address: sysloghost1.lab.com
      - id: 3
        enabled: false
      - id: 4
        enabled: true
        destination_address: 192.168.0.4
        port_number: 514

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

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

Ключ	Описание
error_info словарь	Сведения об ошибке HTTP. Возвращается: при ошибке HTTP Пример: {"error": {"@Message.ExtendedInfo": [{"Message": "Unable to update the Syslog settings because the request contains an invalid number of configurations. The request must contain no more than 4 configurations but contains 5.", "MessageArgs": ["4", "5"], "MessageId": "CAPP1108", "RelatedProperties": [], "Resolution": "Enter only the required number of configurations as identified in the message and retry the operation.", "Severity": "Warning"}], "code": "Base.1.0.GeneralError", "message": "A general error has occurred. See ExtendedInfo for more information."}}
msg строка	Общий статус операции переадресации syslog. Возвращается: всегда Пример: `"Successfully updated the syslog forwarding settings."`
syslog_details список / элементы=строка	Примененный список параметров переадресации syslog. Возвращается: при успешном выполнении Пример: `[{"DestinationAddress": "192.168.10.43", "Enabled": false, "Id": 1, "PortNumber": 514}, {"DestinationAddress": "192.168.10.46", "Enabled": true, "Id": 2, "PortNumber": 514}, {"DestinationAddress": "192.168.10.44", "Enabled": true, "Id": 3, "PortNumber": 514}, {"DestinationAddress": "192.168.10.42", "Enabled": true, "Id": 4, "PortNumber": 515}]`

Авторы

Jagadeesh N V(@jagadeeshnv)
Mangirish Kenkare(@MangirishK)

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

© 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/dellemc/openmanage/ome_application_alerts_syslog_module.html