netapp_eseries.santricity.na_santricity_asup 模块 – NetApp E 系列管理自动支持设置

注意

此模块是 netapp_eseries.santricity 集合 (版本 1.4.1) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install netapp_eseries.santricity

要在剧本中使用它,请指定:netapp_eseries.santricity.na_santricity_asup

概要

  • 允许为单个 E 系列存储系统配置自动支持设置

参数

参数

注释

active

布尔值

启用 ASUP 的主动/预先监控。当我们的监控系统检测到问题时,事件发生时捆绑包可能未包含所有必需的信息。启用此选项允许 NetApp 支持人员手动请求传输或重新传输支持数据以解决问题。

仅当 *state=enabled* 时适用。

选项

  • false

  • true ← (默认)

api_password

字符串 / 必需

用于对 SANtricity Web Services Proxy 或嵌入式 Web Services API 进行身份验证的密码。

api_url

字符串 / 必需

SANtricity Web Services Proxy 或嵌入式 Web Services API 的 URL。

示例 https://prod-1.wahoo.acme.com:8443/devmgr/v2

api_username

字符串 / 必需

用于对 SANtricity Web Services Proxy 或嵌入式 Web Services API 进行身份验证的用户名。

days

别名:schedule_days, days_of_week

列表 / 元素=字符串

将发送 ASUP 捆绑包的星期几列表。较大的每周捆绑包将在指定的一天发送。

选项

  • "monday"

  • "tuesday"

  • "wednesday"

  • "thursday"

  • "friday"

  • "saturday"

  • "sunday"

email

字典

电子邮件传递方法的特定信息。

使用 SMTP 协议。

当 *method==email* 时必需。

sender

字符串

发件人的电子邮件帐户

当 *routing_type==email* 时必需。

server

字符串

邮件服务器的 IP 地址或完全限定域名。

当 *routing_type==email* 时必需。

test_recipient

字符串

测试验证电子邮件

当 *routing_type==email* 时必需。

end

整数

可以在 1 到 24 小时范围内指定结束时间。

ASUP 捆绑包将在提供的开始和结束时间 (UTC) 之间每天发送。

*start* 必须小于 *end*。

默认值: 24

maintenance_duration

整数

ASUP 维护模式处于活动状态的时间持续时间。

允许的范围为 1 到 72 小时。

当 *state==maintenance_enabled* 时必需。

默认值: 24

maintenance_emails

列表 / 元素=字符串

维护通知的电子邮件地址列表。

当 *state==maintenance_enabled* 时必需。

method

字符串

自动支持调度传递方法。

选项

  • "https" ← (默认)

  • "http"

  • "email"

proxy

字典

代理传递方法的特定信息。

当 *(method==https 或 method==http* 且 routing_type==proxy) 时必需。

host

字符串

代理主机 IP 地址或完全限定域名。

当 *method==http 或 method==https* 且 *routing_type==proxy* 时必需。

password

字符串

代理的密码。

port

整数

代理主机端口。

当 *method==http 或 method==https* 且 *routing_type==proxy* 时必需。

script

字符串

自动支持路由脚本文件的路径。

当 *method==http 或 method==https* 且 *routing_type==script* 时必需。

username

字符串

代理的用户名。

routing_type

字符串

自动支持路由

当 *method==https 或 method==http* 时必需。

选项

  • "direct" ← (默认)

  • "proxy"

  • "script"

ssid

字符串

要管理的阵列的 ID。此值对于每个阵列必须唯一。

默认值: "1"

start

整数

可以在 0 到 23 小时范围内指定开始时间。

ASUP 捆绑包将在提供的开始和结束时间 (UTC) 之间每天发送。

*start* 必须小于 *end*。

默认值: 0

state

字符串

启用/禁用 E 系列自动支持配置或维护模式。

启用此选项后,配置、日志和其他与支持相关的信息将转发到 NetApp,以帮助更好地支持您的系统。不会收集任何个人身份信息、密码等。

维护状态启用维护窗口,允许在存储阵列上执行维护活动而不会生成支持案例。

除非先前已启用 ASUP,否则无法启用维护模式。

选项

  • "enabled" ← (默认)

  • "disabled"

  • "maintenance_enabled"

  • "maintenance_disabled"

验证

布尔值

验证ASUP配置。

选项

  • false ← (默认)

  • true

validate_certs

布尔值

是否验证https证书?

选项

  • false

  • true ← (默认)

备注

注意

  • 支持检查模式。

  • 启用ASUP将允许我们的支持团队监控存储系统的日志,以便主动响应系统问题。建议启用所有与ASUP相关的选项,但如果需要,也可以禁用它们。

  • 此API目前仅支持嵌入式Web服务API v2.0及更高版本。

  • E系列Ansible模块需要Web服务代理(WSP)实例可用以管理存储系统,或者支持嵌入式Web服务API的E系列存储系统。

  • 嵌入式Web服务目前在E2800、E5700、EF570及更新的硬件型号上可用。

  • netapp_eseries.santricity.netapp_e_storage_system 可用于配置由WSP实例管理的系统。

示例

- name: Enable ASUP and allow pro-active retrieval of bundles
  na_santricity_asup:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: enabled
    active: true
    days: ["saturday", "sunday"]
    start: 17
    end: 20
- name: Set the ASUP schedule to only send bundles from 12 AM CST to 3 AM CST.
  na_santricity_asup:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: disabled
- name: Set the ASUP schedule to only send bundles from 12 AM CST to 3 AM CST.
  na_santricity_asup:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    state: maintenance_enabled
    maintenance_duration: 24
    maintenance_emails:
      - [email protected]
- name: Set the ASUP schedule to only send bundles from 12 AM CST to 3 AM CST.
  na_santricity_asup:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: maintenance_disabled

返回值

常见的返回值已在此处记录,以下是此模块特有的字段

描述

active

布尔值

如果已启用活动选项,则为True。

返回:成功时

示例: true

asup

布尔值

如果启用了ASUP,则为True。

返回:成功时

示例: true

cfg

复杂

提供完整的ASUP配置。

返回:成功时

asupEnabled

布尔值

如果已启用ASUP,则为True。

返回:成功

daysOfWeek

列表 / 元素=字符串

将发送ASUP捆绑包的星期几。

返回:成功

onDemandEnabled

布尔值

如果已启用ASUP主动监控,则为True。

返回:成功

msg

字符串

成功消息

返回:成功时

示例: "设置已更新。"

作者

  • Michael Price (@lmprice)

  • Nathan Swartz (@swartzn)

  • Vu Tran (@VuTran007)