netapp.ontap.na_ontap_ems_config 模块 – 用于修改 EMS 配置的 NetApp ONTAP 模块。

注意

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

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

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

要在剧本中使用它,请指定:netapp.ontap.na_ontap_ems_config

netapp.ontap 22.8.0 中的新增功能

概要

  • 配置集群的事件通知和日志记录。

要求

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

  • Ansible 2.9 或更高版本 - 建议使用 2.12 或更高版本。

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

参数

参数

注释

cert_filepath

字符串

netapp.ontap 20.6.0 中添加

SSL 客户端证书文件 (.pem) 的路径。

python 2.6 不支持。

feature_flags

字典

netapp.ontap 20.5.0 中添加

启用或禁用新功能。

这可用于启用实验性功能或禁用破坏向后兼容性的新功能。

支持的键和值可能会在未经通知的情况下更改。未知键将被忽略。

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 客户端密钥文件的路径。

mail_from

字符串

事件通知系统用作电子邮件通知“发件人”地址的电子邮件地址。

mail_server

字符串

事件通知系统用于发送事件电子邮件通知的 SMTP 服务器的名称或 IP 地址。

password

别名:pass

字符串

指定用户的密码。

proxy_password

字符串

HTTP 或 HTTPS 代理的密码。

proxy_url

字符串

如果您的组织使用代理,则由 rest-api 类型 EMS 通知目标使用的 HTTP 或 HTTPS 代理服务器 URL。

proxy_user

字符串

如果需要身份验证,则为 HTTP 或 HTTPS 代理服务器的用户名。

pubsub_enabled

布尔值

指示是否将事件发布到发布/订阅消息代理。

需要 ONTAP 9.10 或更高版本。

选项

  • false

  • true

state

字符串

修改 EMS 配置,仅支持 present。

选项

  • "present" ← (默认)

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 ← (默认)

备注

注意

  • 仅支持 REST,并且需要 ONTAP 9.6 或更高版本。

  • 当设置 proxy_password 时,模块不是幂等的。

  • 以 na_ontap 为前缀的模块构建用于支持 ONTAP 存储平台。

  • 默认情况下启用 https,并且推荐使用。要在集群上启用 http,您必须运行以下命令:“set -privilege advanced;”“system services web modify -http-enabled true;”

示例

- name: Modify EMS mail config
  netapp.ontap.na_ontap_ems_config:
    state: present
    mail_from: [email protected]
    mail_server: mail.mycompany.com
    pubsub_enabled: true
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

- name: Modify EMS proxy config
  netapp.ontap.na_ontap_ems_config:
    state: present
    proxy_url: http://proxy.example.com:8080
    pubsub_enabled: true
    proxy_user: admin
    proxy_password: password
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: "{{ validate_certs }}"

作者

  • NetApp Ansible 团队 (@carchi8py)