netapp.ontap.na_ontap_ems_destination 模块 – NetApp ONTAP EMS 事件目标配置

注意

此模块是 netapp.ontap 集合 (版本 22.13.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install netapp.ontap。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定： netapp.ontap.na_ontap_ems_destination。

netapp.ontap 21.23.0 中的新增功能

概要

  • 配置 EMS 目标。

要求

执行此模块的主机需要以下要求。

  • Ansible 2.9 或更高版本 - 建议使用 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 或更高版本。

参数

参数

注释

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 中新增

使用 REST 时覆盖集群 ONTAP 版本。

如果版本与目标集群不匹配，则行为未定义。

这是在由于权限问题无法读取集群版本时的解决方法。请参阅 https://github.com/ansible-collections/netapp.ontap/wiki/Known-issues。

这应采用 9.10 或 9.10.1 的形式，每个元素都是整数。

hostname

字符串 / 必填

ONTAP 实例的主机名或 IP 地址。

http_port

整数

使用此端口覆盖默认端口（80 或 443）

https

布尔值

启用和禁用 https。

使用 REST 时忽略，因为只支持 https。

使用 SSL 证书身份验证时忽略，因为它需要 SSL。

选项

  • false ← (默认)

  • true

key_filepath

字符串

netapp.ontap 20.6.0 中新增

SSL 客户端密钥文件的路径。

name

字符串 / 必填

EMS 目标的名称。

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

字符串

Syslog 传输协议。

选项

  • "udp_unencrypted" ← (默认)

  • "tcp_unencrypted"

  • "tcp_encrypted"

type

字符串 / 必填

EMS 目标的类型。

选项

  • "email"

  • "syslog"

  • "rest_api"

use_rest

字符串

此模块仅支持 REST。

always – 将始终使用 REST API。如果模块不支持 REST，则会发出警告。

默认值： "always"

username

别名：user

字符串

这可以是集群范围或 SVM 范围的帐户，具体取决于是否需要集群级或 SVM 级 API。

有关更多信息，请阅读文档 https://mysupport.netapp.com/NOW/download/software/nmsdk/9.4/。

支持两种身份验证方法

  1. 基本身份验证，使用用户名和密码；

  2. SSL证书身份验证，使用SSL客户端证书文件，并可选择使用私钥文件。

要使用证书，必须已在ONTAP集群中安装该证书，并且必须已启用证书身份验证。

validate_certs

布尔值

如果设置为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: [email protected]
    hostname: "{{hostname}}"
    username: "{{username}}"
    password: "{{password}}"

作者

  • Bartosz Bielawski (@bielawb)