netapp.ontap.na_ontap_autosupport 模块 – NetApp ONTAP 自动支持

注意

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

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

要安装它,请使用:ansible-galaxy collection install netapp.ontap。您需要进一步的要求才能使用此模块,请参阅 要求 以了解详细信息。

要在 playbook 中使用它,请指定:netapp.ontap.na_ontap_autosupport

netapp.ontap 2.7.0 中的新增功能

概要

  • 启用/禁用自动支持

要求

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

  • 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 或更高版本。

参数

参数

注释

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 的形式,每个元素都是一个整数。

use_rest 设置为自动时,这可能会强制根据版本和平台功能切换到基于 ZAPI 的版本。

使用 ZAPI 时忽略。

from_address

字符串

在 netapp.ontap 2.8.0 中添加

指定节点发送自动支持消息的电子邮件地址。

hostname

字符串 / 必需

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

hostname_in_subject

布尔值

在 netapp.ontap 2.8.0 中添加

指定是否在自动支持消息的主题行中包含节点的主机名。

选项

  • false

  • true

http_port

整数

使用此端口覆盖默认端口(80 或 443)

https

布尔值

启用和禁用 https。

使用 REST 时忽略,因为仅支持 https。

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

选项

  • false ← (默认)

  • true

key_filepath

字符串

在 netapp.ontap 20.6.0 中添加

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

local_collection_enabled

布尔值

在 netapp.ontap 21.5.0 中添加

指定在禁用自动支持守护程序时是否收集自动支持数据。

选项

  • false

  • true

mail_hosts

列表 / 元素=字符串

用于通过 SMTP 传递自动支持消息的邮件服务器列表。

主机名和 IP 地址都可以用作有效输入。

max_http_size

整数

在 netapp.ontap 21.5.0 中添加

指定 HTTP 传输协议的传递大小限制(以字节为单位)。

max_smtp_size

整数

在 netapp.ontap 21.5.0 中添加

指定 SMTP 传输协议的传递大小限制(以字节为单位)。

nht_data_enabled

布尔值

在 netapp.ontap 21.5.0 中添加

指定是否将磁盘运行状况数据作为自动支持数据的一部分进行收集。

选项

  • false

  • true

node_name

字符串 / 必需

拥有自动支持配置的文件服务器的名称。

noteto

列表 / 元素=字符串

指定最多五个短自动支持电子邮件消息的收件人。

ondemand_enabled

布尔值

在 netapp.ontap 21.5.0 中添加

指定是否启用自动支持按需下载功能。

选项

  • false

  • true

ontapi

整数

要使用的 ontap API 版本

partner_addresses

列表 / 元素=字符串

在 netapp.ontap 2.8.0 中添加

指定最多五个完整自动支持电子邮件消息的合作伙伴供应商收件人。

password

别名:pass

字符串

指定用户的密码。

perf_data_enabled

布尔值

在 netapp.ontap 21.5.0 中添加

指定是否将性能数据作为自动支持数据的一部分进行收集。

选项

  • false

  • true

post_url

字符串

用于通过 HTTP POST 传递自动支持消息的 URL。

private_data_removed

布尔值

在 netapp.ontap 21.5.0 中添加

指定删除客户提供的数据。

选项

  • false

  • true

proxy_url

字符串

在 netapp.ontap 2.8.0 中添加

如果“transport”参数设置为 HTTP 或 HTTPS 并且您的组织使用代理,请指定 HTTP 或 HTTPS 代理。

如果需要身份验证,请使用“username:password@host:port”格式。

reminder_enabled

布尔值

在 netapp.ontap 21.5.0 中添加

指定是否启用或禁用自动支持提醒。

选项

  • false

  • true

retry_count

整数

在 netapp.ontap 21.5.0 中添加

指定自动支持消息的最大传递尝试次数。

state

字符串

指定是否存在自动支持守护程序。

当此设置不存在时,将关闭所有自动支持消息的传递。

选项

  • "present" ← (默认)

  • "absent"

support

布尔值

指定是否启用向技术支持的自动支持通知。

选项

  • false

  • true

to_addresses

列表 / 元素=字符串

在 netapp.ontap 2.8.0 中添加

指定最多五个完整 AutoSupport 电子邮件消息的收件人。

传输协议

字符串

用于传递 AutoSupport 消息的传输协议名称。

选项

  • "http"

  • "https"

  • "smtp"

使用_rest

字符串

是否使用 REST 或 ZAPI。

always – 如果模块支持 REST API,则始终使用 REST API。如果模块不支持 REST,则会发出警告。如果模块选项在 REST 中不支持,则会发出错误。

never – 如果模块支持 ZAPI,则始终使用 ZAPI。如果 REST 选项在 ZAPI 中不支持,则可能会发出错误。

auto – 如果模块支持 REST 并且模块选项受支持,则尝试使用 REST API。否则,将恢复为 ZAPI。

默认值: "auto"

用户名

别名:user

字符串

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

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

支持两种身份验证方法

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

  2. SSL 证书身份验证,使用 SSL 客户端证书文件,以及可选的私钥文件。

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

验证_证书

布尔值

如果设置为 no,则不会验证 SSL 证书。

仅应在个人控制的站点上使用自签名证书时,将其设置为 False

选项

  • false

  • true ← (默认)

验证_数字_证书

布尔值

在 netapp.ontap 21.5.0 中添加

设置为 true 时,每个节点将验证其收到的数字证书。

选项

  • false

  • true

注释

注意

  • 前缀为 na_ontap 的模块旨在支持 ONTAP 存储平台。

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

示例

- name: Enable autosupport
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: present
    node_name: test
    transport: https
    noteto: [email protected],[email protected]
    mail_hosts: 1.2.3.4,5.6.7.8
    support: False
    post_url: url/1.0/post
- name: Modify autosupport proxy_url with password
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: present
    node_name: test
    transport: https
    proxy_url: username:[email protected]:8000
- name: Modify autosupport proxy_url without password
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: present
    node_name: test
    transport: https
    proxy_url: [email protected]:8000
- name: Disable autosupport
  netapp.ontap.na_ontap_autosupport:
    hostname: "{{ hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    state: absent
    node_name: test

作者

  • NetApp Ansible 团队 (@carchi8py)