Модуль dellemc.openmanage.ome_application_alerts_syslog – Настройка переадресации syslog на OpenManage Enterprise и OpenManage Enterprise Modular

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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	Файл PEM (Privacy Enhanced Mail), содержащий сертификат CA, используемый для проверки.
hostname строка / обязательно	IP-адрес или имя хоста OpenManage Enterprise или OpenManage Enterprise Modular.
password строка	Пароль OpenManage Enterprise или OpenManage Enterprise Modular. Если пароль не указан, используется переменная среды `OME_PASSWORD`. Пример: export OME_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=имя_пользователя
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)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/dellemc/openmanage/ome_application_alerts_syslog_module.html