модуль netapp.ontap.na_ontap_ems_destination – настройка NetApp ONTAP для назначения событий EMS

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 23.5.0).

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

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

Чтобы использовать модуль в сценарии, укажите: netapp.ontap.na_ontap_ems_destination.

Добавлено в netapp.ontap 21.23.0

Краткое описание
Требования
Параметры
Примечания
Примеры

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

Настройка назначения EMS.

Требования

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

Ansible 2.9 или более поздней версии — рекомендуется версия 2.12 или более поздняя.
Python3 — рекомендуется версия 3.9 или более поздняя.
netapp-lib только при использовании ZAPI (установите с помощью «pip install netapp-lib»). Обратите внимание, что netapp-lib устарел и больше не поддерживается. Используйте его на свой страх и риск.
Физическая или виртуальная кластерная система Data ONTAP; модули поддерживают Data ONTAP 9.1 и более поздние версии, для поддержки REST требуется ONTAP 9.6 или более поздняя версия.

Параметры

Параметр	Комментарии
ca string добавлено в netapp.ontap 22.8.0	Имя сертификата CA
cert_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу сертификата клиента SSL (.pem). Не поддерживается в Python 2.6.
certificate string добавлено в netapp.ontap 22.8.0	Имя сертификата
destination string / обязательный	Назначение — содержимое зависит от типа.
feature_flags dictionary добавлено в netapp.ontap 20.5.0	Включение или отключение новой функции. Параметр можно использовать для включения экспериментальной функции или отключения новой функции, нарушающей обратную совместимость. Поддерживаемые ключи и значения могут изменяться без предварительного уведомления. Неизвестные ключи игнорируются.
filters list / элементы=string / обязательный	Список фильтров, с которыми связано назначение.
force_ontap_version string добавлено в netapp.ontap 21.23.0	Переопределение версии ONTAP кластера при использовании REST. Поведение не определено, если версия не соответствует целевому кластеру. Этот параметр предоставляется как обходное решение на случай, если версию кластера невозможно прочитать из-за проблем с разрешениями. См. https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. Значение должно иметь формат 9.10 или 9.10.1, где каждый компонент является целым числом.
hostname string / обязательный	Имя хоста или IP-адрес экземпляра ONTAP.
http_port integer	Переопределение порта по умолчанию (80 или 443) этим портом
https boolean	Включение и отключение HTTPS. Игнорируется при использовании REST, так как поддерживается только HTTPS. Игнорируется при использовании аутентификации по SSL-сертификату, так как для неё требуется SSL. Варианты: `false` ← (по умолчанию) `true`
key_filepath string добавлено в netapp.ontap 20.6.0	Путь к файлу ключа клиента SSL.
name string / обязательный	Имя назначения EMS.
password псевдонимы: pass string	Пароль указанного пользователя.
state string	Должно ли назначение существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
syslog dictionary добавлено в netapp.ontap 22.9.0	Параметр указывается, если тип назначения EMS — `syslog`.
hostname_format_override string	Переопределение формата имени хоста Syslog. Варианты: `"no_override"` ← (по умолчанию) `"fqdn"` `"hostname_only"`
message_format string	Формат сообщений Syslog. Варианты: `"legacy_netapp"` ← (по умолчанию) `"rfc_5424"`
port integer	Порт Syslog. По умолчанию: `514`
timestamp_format_override string	Переопределение формата временной метки Syslog. Варианты: `"no_override"` ← (по умолчанию) `"rfc_3164"` `"iso_8601_local_time"` `"iso_8601_utc"`
transport string	Транспортный протокол Syslog. Варианты: `"udp_unencrypted"` ← (по умолчанию) `"tcp_unencrypted"` `"tcp_encrypted"`
type string / обязательный	Тип назначения EMS. Варианты: `"email"` `"syslog"` `"rest_api"`
use_lambda boolean добавлено в netapp.ontap 23.4.0	Указывает, следует ли использовать функцию прокси-сервера AWS Lambda для подключения к системе ONTAP. Поддерживается только с REST. Варианты: `false` ← (по умолчанию) `true`
use_rest string	Этот модуль поддерживает только REST. always -- всегда использовать REST API. Если модуль не поддерживает REST, выводится предупреждение. По умолчанию: `"always"`
username псевдонимы: user string	Это может быть учётная запись уровня кластера или уровня SVM — в зависимости от того, требуется ли API уровня кластера или SVM. Дополнительную информацию см. в документации: https://docs.netapp.com/us-en/ontap/authentication/create-svm-user-accounts-task.html. Поддерживаются два метода аутентификации Базовая аутентификация с использованием имени пользователя и пароля. Аутентификация по SSL-сертификату с использованием файла сертификата клиента SSL и, при необходимости, файла закрытого ключа. Для использования сертификата он должен быть установлен в кластере ONTAP, а аутентификация по сертификату должна быть включена.
validate_certs boolean	Если установлено значение `no`, сертификаты SSL не будут проверяться. Устанавливайте значение `False` только на сайтах под личным контролем, использующих самоподписанные сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Поддерживается check_mode.
Этот модуль поддерживает только REST.
Модули с префиксом na_ontap предназначены для поддержки платформы хранения ONTAP.
HTTPS включён по умолчанию и рекомендуется к использованию. Чтобы включить HTTP в кластере, выполните следующие команды: ‘set -privilege advanced;’ ‘system services web modify -http-enabled true;’

Примеры

- name: Configure REST EMS destination
  netapp.ontap.na_ontap_ems_destination:
    state: present
    name: rest
    type: rest_api
    filters: ['important_events']
    destination: http://my.rest.api/address
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Configure REST EMS destination with a certificate
  netapp.ontap.na_ontap_ems_destination:
    state: present
    name: rest
    type: rest_api
    filters: ['important_events']
    destination: http://my.rest.api/address
    certificate: my_cert
    ca: my_cert_ca
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Configure REST EMS destination with type syslog
  netapp.ontap.na_ontap_ems_destination:
    state: present
    name: syslog_destination
    type: syslog
    filters: ['important_events']
    destination: http://my.rest.api/address
    certificate: my_cert
    ca: my_cert_ca
    syslog:
      transport: udp_unencrypted
      port: 514
      message_format: legacy_netapp
      hostname_format_override: no_override
      timestamp_format_override: no_override
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

- name: Remove email EMS destination
  netapp.ontap.na_ontap_ems_destination:
    state: absent
    name: email_destination
    type: email
    filters: ['important_events']
    destination: netapp@company.com
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    hostname: "{{ netapp_hostname }}"

Авторы

Bartosz Bielawski (@bielawb)

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

© 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/netapp/ontap/na_ontap_ems_destination_module.html