Модуль hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting – управление настройками журнала событий блочной системы хранения Hitachi SDS.

Примечание

Этот модуль входит в коллекцию hitachivantara.vspone_block (версия 4.8.1).

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

Чтобы установить её, используйте: ansible-galaxy collection install hitachivantara.vspone_block. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting.

Новое в hitachivantara.vspone_block 4.6.0

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

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

Этот модуль позволяет настраивать параметры журнала событий.
Он поддерживает обновление параметров пересылки syslog и параметров отчётов по электронной почте.
Примеры см. по URL https://github.com/hitachi-vantara/vspone-block-ansible/blob/main/playbooks/sds_block_direct/event_log_setting.yml

Требования

Следующие требования необходимы на хосте, выполняющем этот модуль.

python >= 3.9

Параметры

Параметр	Комментарии
connection_info dictionary / обязательный	Информация, необходимая для подключения к системе хранения.
address string / обязательный	IP-адрес или имя хоста системы хранения.
connection_type string	Тип подключения к системе хранения. Варианты: `"direct"` ← (по умолчанию)
password string / обязательный	Пароль для аутентификации. Обязательное поле.
username string / обязательный	Имя пользователя для аутентификации. Обязательное поле.
spec dictionary	Спецификация задачи настройки журнала событий.
email_report_setting dictionary	Конфигурация отчётов по электронной почте.
smtp_settings list / элементы=dictionary	Список параметров SMTP-серверов.
connection_encryption_type string	Тип шифрования соединения для SMTP. Варианты: `"None"` `"STARTTLS"` `"SSL/TLS"`
from_address string	Адрес отправителя электронной почты.
index integer / обязательный	Индекс SMTP-сервера. Варианты: `1` `2`
is_enabled boolean	Указывает, включён ли SMTP-сервер. Варианты: `false` `true`
is_smtp_auth_enabled boolean	Указывает, включена ли аутентификация SMTP. Варианты: `false` `true`
port integer	Номер порта SMTP-сервера.
smtp_auth_account string	Учётная запись для аутентификации SMTP.
smtp_auth_password string	Пароль для аутентификации SMTP.
smtp_server_name string	Имя или IP-адрес SMTP-сервера.
to_address1 string	Основной адрес получателя электронной почты.
to_address2 string	Дополнительный адрес получателя электронной почты.
to_address3 string	Третий адрес получателя электронной почты.
smtp_root_certificate dictionary	Конфигурация корневого сертификата SMTP-сервера. Это обязательное поле, если для поля state задано значение `import_smtp_certificate` или `download_smtp_certificate`.
certificate_path string	Абсолютный путь к файлу сертификата для импорта. Обязателен, если для state задано значение `import_smtp_certificate`.
download_location string	Путь к каталогу, в который будет загружен сертификат. Обязателен, если для state задано значение `download_smtp_certificate`.
target_smtp_server integer	Индекс SMTP-сервера, для которого нужно импортировать или загрузить сертификат. Варианты: `1` ← (по умолчанию) `2`
syslog_forwarding_setting dictionary	Конфигурация пересылки syslog.
location_name string	Название местоположения для пересылки syslog.
syslog_servers list / элементы=dictionary	Список конфигураций серверов syslog.
index integer / обязательный	Индекс сервера syslog. Варианты: `1` `2`
is_enabled boolean	Указывает, включён ли сервер syslog. Варианты: `false` `true` ← (по умолчанию)
port integer	Номер порта сервера syslog. По умолчанию: `514`
server_name string / обязательный	Имя или IP-адрес сервера syslog.
transport_protocol string	Транспортный протокол для сервера syslog. Варианты: `"UDP"` ← (по умолчанию)
state string	Уровень задачи настройки журнала событий. Возможные значения: `present`, `import_smtp_certificate` и `download_smtp_certificate`. Варианты: `"present"` ← (по умолчанию) `"import_smtp_certificate"` `"download_smtp_certificate"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Определяет, должен ли модуль выполняться в режиме проверки.

Примеры

- name: Configure event log settings with syslog forwarding
  hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      syslog_forwarding_setting:
        location_name: "datacenter1"
        syslog_servers:
          - index: 1
            is_enabled: true
            server_name: "syslog.example.com"
            port: 514
            transport_protocol: "UDP"
          - index: 2
            is_enabled: false
            server_name: "backup-syslog.example.com"
            port: 514
            transport_protocol: "UDP"

- name: Configure event log settings with email reporting
  hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      email_report_setting:
        smtp_settings:
          - index: 1
            is_enabled: true
            smtp_server_name: "smtp.example.com"
            port: 587
            connection_encryption_type: "STARTTLS"
            is_smtp_auth_enabled: true
            smtp_auth_account: "eventlog@example.com"
            smtp_auth_password: "secure_password"
            from_address: "storage-alerts@example.com"
            to_address1: "admin@example.com"
            to_address2: "team@example.com"
            to_address3: ""

- name: Update syslog server configuration
  hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting:
    state: present
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      syslog_forwarding_setting:
        location_name: "datacenter1"
        syslog_servers:
          - index: 1
            is_enabled: true
            server_name: "new-syslog.example.com"
            port: 1514
            transport_protocol: "UDP"

- name: Import SMTP root certificate for SMTP server 1
  hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting:
    state: import_smtp_certificate
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      smtp_root_certificate:
        certificate_path: "/etc/ssl/certs/smtp_root_ca.pem"
        target_smtp_server: 1

- name: Import SMTP root certificate for SMTP server 2
  hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting:
    state: import_smtp_certificate
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      smtp_root_certificate:
        certificate_path: "/etc/ssl/certs/smtp_root_ca.pem"
        target_smtp_server: 2

- name: Download SMTP root certificate from server 1
  hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting:
    state: download_smtp_certificate
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      smtp_root_certificate:
        download_location: "/tmp/certificates"
        # target_smtp_server: 1  # Optional - defaults to 1

- name: Download SMTP root certificate from server 2
  hitachivantara.vspone_block.sds_block.hv_sds_block_event_log_setting:
    state: download_smtp_certificate
    connection_info:
      address: sdsb.company.com
      username: "admin"
      password: "password"
    spec:
      smtp_root_certificate:
        download_location: "/tmp/certificates"
        target_smtp_server: 2

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

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

Ключ	Описание
event_log_settings dictionary	Словарь с настроенными параметрами журнала событий. Возвращается: всегда
emailReportSetting dictionary	Сведения о конфигурации отчётов по электронной почте. Возвращается: success
smtpSettings list / elements=dictionary	Список настроенных SMTP-серверов. Возвращается: success
connectionEncryptionType string	Тип шифрования соединения. Возвращается: success Пример: `"STARTTLS"`
fromAddress string	Адрес отправителя электронной почты. Возвращается: success Пример: `"storage-alerts@example.com"`
index integer	Индекс SMTP-сервера. Возвращается: success Пример: `1`
isEnabled boolean	Указывает, включён ли SMTP-сервер. Возвращается: success Пример: `true`
isSmtpAuthEnabled boolean	Указывает, включена ли аутентификация SMTP. Возвращается: success Пример: `true`
port integer	Номер порта SMTP-сервера. Возвращается: success Пример: `587`
smtpAuthAccount string	Учётная запись для аутентификации SMTP. Возвращается: success Пример: `"eventlog@example.com"`
smtpServerName string	Имя или IP-адрес SMTP-сервера. Возвращается: success Пример: `"smtp.example.com"`
toAddress1 string	Основной адрес получателя. Возвращается: success Пример: `"admin@example.com"`
toAddress2 string	Дополнительный адрес получателя. Возвращается: success Пример: `"team@example.com"`
toAddress3 string	Третий адрес получателя. Возвращается: success Пример: `""`
syslogForwardingSetting dictionary	Сведения о конфигурации пересылки Syslog. Возвращается: success
locationName string	Название расположения для пересылки Syslog. Возвращается: success Пример: `"datacenter1"`
syslogServers list / elements=dictionary	Список настроенных серверов Syslog. Возвращается: success
index integer	Индекс сервера Syslog. Возвращается: success Пример: `1`
isEnabled boolean	Указывает, включён ли сервер Syslog. Возвращается: success Пример: `true`
port integer	Номер порта сервера Syslog. Возвращается: success Пример: `514`
serverName string	Имя или IP-адрес сервера Syslog. Возвращается: success Пример: `"syslog.example.com"`
transportProtocol string	Транспортный протокол для сервера Syslog. Возвращается: success Пример: `"UDP"`

Авторы

Hitachi Vantara LTD (@hitachi-vantara)

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

© 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/hitachivantara/vspone_block/sds_block.hv_sds_block_event_log_setting_module.html