netapp.ontap.na_ontap_log_forward 模块 – 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_log_forward。

netapp.ontap 21.2.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 不支持。

destination

字符串 / 必需

日志消息将转发到的目标地址。可以是主机名或 IP 地址。

facility

字符串

用于指示生成消息的软件类型的设备代码。

选项

  • "kern"

  • "user"

  • "local0"

  • "local1"

  • "local2"

  • "local3"

  • "local4"

  • "local5"

  • "local6"

  • "local7"

feature_flags

字典

netapp.ontap 20.5.0 中新增

启用或禁用新功能。

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

支持的键和值可能会更改，恕不另行通知。未知键将被忽略。

force

布尔值

跳过连接测试

选项

  • false

  • true

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 设置为 auto 时，这可能会根据版本和平台功能强制切换到 ZAPI。

ZAPI 中忽略。

hostname

字符串 / 必需

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

http_port

整数

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

https

布尔值

启用和禁用 https。

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

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

选项

  • false ← (默认)

  • true

key_filepath

字符串

netapp.ontap 20.6.0 中新增

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

ontapi

整数

要使用的 ontap api 版本

password

别名：pass

字符串

指定用户的密码。

port

整数 / 必需

用于转发消息的目标端口。

protocol

字符串

日志转发协议

选项

  • "udp_unencrypted"

  • "tcp_unencrypted"

  • "tcp_encrypted"

state

字符串

日志转发配置是否存在

选项

  • "present" ← (默认)

  • "absent"

use_rest

字符串

是否使用 REST 或 ZAPI。

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

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

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

默认值： "auto"

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

verify_server

布尔值

验证目标服务器身份

选项

  • false

  • true

备注

注意

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

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

示例

- name: Create log forward configuration
  na_ontap_log_forward:
    state: present
    destination: 10.11.12.13
    port: 514
    protocol: udp_unencrypted
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

- name: Modify log forward configuration
  na_ontap_log_forward:
    state: present
    destination: 10.11.12.13
    port: 514
    protocol: tcp_unencrypted
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

- name: Delete log forward configuration
  na_ontap_log_forward:
    state: absent
    destination: 10.11.12.13
    port: 514
    username: "{{ username }}"
    password: "{{ password }}"
    hostname: "{{ hostname }}"

作者

  • NetApp Ansible 团队 (@carchi8py)