netapp.ontap.na_ontap_snmp 模块 – NetApp ONTAP SNMP 用户

注意

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

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

要安装它，请使用： ansible-galaxy collection install netapp.ontap。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定： netapp.ontap.na_ontap_snmp。

netapp.ontap 2.6.0 中的新增功能

概要

  • 创建/删除 SNMP 用户。

要求

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

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

参数

参数

注释

access_control

字符串

社区的访问控制。唯一支持的值是“ro”（只读）。

在 REST 中被忽略。

选项

  • "ro" ← (默认)

authentication_method

字符串

netapp.ontap 22.8.0 中新增

SNMP 用户的身份验证方法。

仅在 REST 中受支持。默认值为 community。

选项

  • "community"

  • "usm"

  • "both"

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 设置为 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

字符串

指定用户的密码。

snmp_username

字符串 / 必需

netapp.ontap 22.8.0 中新增

要管理的 SNMP 用户的名称。

snmpv3

字典

netapp.ontap 22.8.0 中新增

仅当 authentication_method 为 usm 或 both 时指定。

此选项定义 SNMPv3 用户（也称为 usm 用户）的 SNMPv3 凭据。

仅在 REST 中受支持。

authentication_password

字符串 / 必需

身份验证协议密码。

authentication_protocol

字符串

SNMPv3 的身份验证协议。

选项

  • "none" ← (默认)

  • "md5"

  • "sha"

  • "sha2_256"

privacy_password

字符串 / 必需

隐私协议密码。

privacy_protocol

字符串

SNMPv3 的隐私协议。

选项

  • "none" ← (默认)

  • "des"

  • "aes128"

state

字符串

指定的 SNMP 用户是否应该存在。

选项

  • "present" ← (默认)

  • "absent"

use_rest

字符串

是否使用 REST 或 ZAPI。

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

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

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 集群中安装证书，并且必须已启用证书身份验证。

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

备注

注意

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

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

示例

- name: Create SNMP community (ZAPI only)
  netapp.ontap.na_ontap_snmp:
    state: present
    snmp_username: communityName
    access_control: 'ro'
    use_rest: never
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create SNMP community (snmpv1 or snmpv2) (REST only)
  netapp.ontap.na_ontap_snmp:
    state: present
    snmp_username: communityName
    use_rest: always
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create SNMP user (snmpv3) (REST only)
  netapp.ontap.na_ontap_snmp:
    state: present
    snmp_username: username
    use_rest: always
    authentication_method: usm
    snmpv3:
      authentication_protocol: sha
      authentication_password: humTdumt*@t0nAwa21
      privacy_protocol: aes128
      privacy_password: p@**GOandCLCt*300
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete SNMP community (ZAPI only)
  netapp.ontap.na_ontap_snmp:
    state: absent
    snmp_username: communityName
    access_control: 'ro'
    use_rest: never
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete SNMP community (snmpv1 or snmpv2) (REST only)
  netapp.ontap.na_ontap_snmp:
    state: absent
    snmp_username: communityName
    use_rest: always
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete SNMP user (snmpv3) (REST only)
  netapp.ontap.na_ontap_snmp:
    state: absent
    snmp_username: username
    use_rest: always
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

作者

  • NetApp Ansible 团队 (@carchi8py)