netapp_eseries.santricity.na_santricity_syslog 模块 – NetApp E 系列管理 syslog 设置

注意

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

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

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

要在 playbook 中使用它,请指定:netapp_eseries.santricity.na_santricity_syslog

概要

  • 允许为单个 E 系列存储系统配置 syslog 设置

参数

参数

注释

地址

字符串

syslog 服务器的 IPv4 地址或完全限定的主机名。

当 *state=absent* 且 *address=None* 时,所有现有的 syslog 配置都将被删除。

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 进行身份验证的用户名。

组件

列表 / 元素=字符串

e 系列日志记录组件定义要传输到 syslog 服务器的特定日志。

在编写本文时,“auditLog”是唯一的日志记录组件,但可能会有更多可用组件。

默认值: ["auditLog"]

端口

整数

这是 syslog 服务器正在使用的端口。

默认值: 514

协议

字符串

这是 syslog 服务器用于接收 syslog 消息的传输协议。

选项

  • "udp" ← (默认)

  • "tcp"

  • "tls"

ssid

字符串

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

默认值: "1"

状态

字符串

为 E 系列存储阵列添加或删除 syslog 服务器配置。

当现有 syslog 服务器配置的地址与 *address* 匹配时,它将被删除或更新。

解析为与 *address* 匹配的 IPv4 地址的完全限定主机名将不被视为匹配。

选项

  • "present" ← (默认)

  • "absent"

测试

布尔值

这会强制将测试 syslog 消息发送到指定的 syslog 服务器。

仅在 *state=present* 时尝试传输。

选项

  • false ← (默认)

  • true

validate_certs

布尔值

是否应验证 https 证书?

选项

  • false

  • true ← (默认)

注释

注意

  • 支持检查模式。

  • 此 API 目前仅支持嵌入式 Web Services API v2.12(与 SANtricity OS 11.40.2 捆绑)及更高版本。

  • E 系列 Ansible 模块需要 Web Services Proxy (WSP) 的实例才能管理存储系统,或者需要支持嵌入式 Web Services API 的 E 系列存储系统。

  • 嵌入式 Web Services 目前在 E2800、E5700、EF570 和较新的硬件型号上可用。

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

示例

- name: Add two syslog server configurations to NetApp E-Series storage array.
  na_santricity_syslog:
    ssid: "1"
    api_url: "https://192.168.1.100:8443/devmgr/v2"
    api_username: "admin"
    api_password: "adminpass"
    validate_certs: true
    state: present
    address: "{{ item }}"
    port: 514
    protocol: tcp
    component: "auditLog"
  loop:
    - "192.168.1.1"
    - "192.168.1.100"

返回值

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

描述

msg

字符串

成功消息

已返回:成功时

示例: "设置已更新。"

syslog

布尔值

如果 syslog 服务器配置已添加到 e 系列存储阵列,则为 True。

已返回:成功时

示例: true

作者

  • Nathan Swartz (@swartzn)

  • Vu Tran (@VuTran007)