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

Примечание

Этот модуль входит в коллекцию netapp.ontap (версия 22.12.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 или более поздней версии, рекомендуется Ansible 2.12 или более поздней.
Python3 3.9 или более поздней версии, рекомендуется.
При использовании ZAPI, netapp-lib 2018.11.13 или более поздней версии (установка с помощью «pip install netapp-lib»), настоятельно рекомендуется netapp-lib 2020.3.12, так как она обеспечивает более подробные сообщения об ошибках при подключении.
Физическая или виртуальная кластеризованная система Data ONTAP. Модули поддерживают Data ONTAP 9.1 и более поздние версии. Поддержка REST требует ONTAP 9.6 или более поздней версии.

Параметры

END_OF_DOCUMENT_MARKER

Параметр	Комментарии
ca строка добавлено в netapp.ontap 22.8.0	Имя сертификата CA
cert_filepath строка добавлено в netapp.ontap 20.6.0	путь к файлу SSL-сертификата клиента (.pem). не поддерживается с python 2.6.
certificate строка добавлено в netapp.ontap 22.8.0	Имя сертификата
destination строка / обязательно	Назначение - содержимое зависит от типа.
feature_flags словарь добавлено в netapp.ontap 20.5.0	Включить или выключить новую функцию. Это может быть использовано для включения экспериментальной функции или выключения новой функции, которая нарушает обратную совместимость. Поддерживаемые ключи и значения могут быть изменены без предварительного уведомления. Неизвестные ключи игнорируются.
filters список / элементы=строка / обязательно	Список фильтров, к которым привязано назначение.
force_ontap_version строка добавлено в netapp.ontap 21.23.0	Переопределить версию кластера ONTAP при использовании REST. Поведение не определено, если версия не соответствует целевому кластеру. Это предоставляется как обходное решение, когда версия кластера не может быть прочитана из-за проблем с разрешениями. См. https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues. Должно быть в формате 9.10 или 9.10.1, где каждый элемент — целое число. Когда `use_rest` установлено в auto, это может принудительно переключиться на ZAPI в зависимости от версии и возможностей платформы. Игнорируется с ZAPI.
hostname строка / обязательно	Имя хоста или IP-адрес экземпляра ONTAP.
http_port целое число	Переопределить порт по умолчанию (80 или 443) на этот порт
https булево	Включить и выключить https. Игнорируется при использовании REST, так как поддерживается только https. Игнорируется при аутентификации с помощью SSL-сертификата, так как она требует SSL. Варианты: `false` ← (по умолчанию) `true`
key_filepath строка добавлено в netapp.ontap 20.6.0	путь к файлу ключа SSL-клиента.
name строка / обязательно	Имя назначения EMS.
ontapi целое число	Используемая версия API ontap
password псевдонимы: pass строка	Пароль для указанного пользователя.
state строка	Необходимо ли наличие назначения. Варианты: `"present"` ← (по умолчанию) `"absent"`
syslog словарь добавлено в netapp.ontap 22.9.0	Параметр указывается, когда тип назначения EMS — `syslog`.
hostname_format_override строка	Переопределение формата имени хоста Syslog. Варианты: `"no_override"` ← (по умолчанию) `"fqdn"` `"hostname_only"`
message_format строка	Формат сообщения Syslog. Варианты: `"legacy_netapp"` ← (по умолчанию) `"rfc_5424"`
port целое число	Порт Syslog. По умолчанию: `514`
timestamp_format_override строка	Переопределение формата метки времени Syslog. Варианты: `"no_override"` ← (по умолчанию) `"rfc_3164"` `"iso_8601_local_time"` `"iso_8601_utc"`

transport string	Протокол Syslog Transport. Варианты: `"udp_unencrypted"` ← (по умолчанию) `"tcp_unencrypted"` `"tcp_encrypted"`
type string / обязательно	Тип назначения EMS. Варианты: `"email"` `"syslog"` `"rest_api"`
use_rest string	Использовать REST или ZAPI. always – всегда будет использовать REST API, если модуль поддерживает REST. Выводится предупреждение, если модуль не поддерживает REST. Возникает ошибка, если опция модуля не поддерживается в REST. never – всегда будет использовать ZAPI, если модуль поддерживает ZAPI. Возможна ошибка, если опция REST не поддерживается в ZAPI. auto – будет пытаться использовать REST API, если модуль поддерживает REST и опции модуля поддерживаются. В противном случае переходит к ZAPI. По умолчанию: `"auto"`
username псевдонимы: user string	Это может быть учетная запись уровня кластера или SVM, в зависимости от того, требуется ли API уровня кластера или SVM. Дополнительную информацию можно найти в документации https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/. Поддерживаются два метода аутентификации базовая аутентификация, используя имя пользователя и пароль, аутентификация по сертификату 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
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"

- 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
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"

- 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
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"

- 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
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"

Авторы

Bartosz Bielawski (@bielawb)

Ссылки на сборку

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