netapp.ontap.na_ontap_unix_user 模块 – NetApp ONTAP UNIX 用户

注意

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

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

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

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

netapp.ontap 2.8.0 中的新增功能

概要

  • 创建、删除或修改 ONTAP 本地的 UNIX 用户。

要求

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

  • 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 设置为 auto 时,这可能会强制切换到基于版本和平台功能的 ZAPI。

使用 ZAPI 时忽略。

full_name

字符串

指定 UNIX 用户的全名

REST 支持需要 ONTAP 版本 9.9.0 或更高版本。

创建时可选,可修改。

hostname

字符串 / 必需

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

http_port

整数

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

https

布尔值

启用和禁用 https。

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

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

选择

  • false ← (默认)

  • true

id

整数

指定 UNIX 用户的标识号。

REST 支持需要 ONTAP 版本 9.9.0 或更高版本。

创建时必需,可修改。

key_filepath

字符串

在 netapp.ontap 20.6.0 中添加

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

name

字符串 / 必需

指定用户的 UNIX 帐户名。

REST 支持需要 ONTAP 版本 9.9.0 或更高版本。

不可修改。

ontapi

整数

要使用的 ontap api 版本

password

别名:pass

字符串

指定用户的密码。

primary_gid

别名:group_id

整数

在 netapp.ontap 21.21.0 中添加

指定 UNIX 用户的主组标识号。

REST 支持需要 ONTAP 版本 9.9.0 或更高版本。

创建时必需,可修改。

state

字符串

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

选择

  • "present" ← (默认)

  • "absent"

use_rest

字符串

是否使用 REST 或 ZAPI。

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

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

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

vserver

字符串 / 必需

指定 UNIX 用户的 Vserver。

REST 支持需要 ONTAP 版本 9.9.0 或更高版本。

不可修改。

注释

注意

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

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

示例

- name: Create UNIX User
  netapp.ontap.na_ontap_unix_user:
    state: present
    name: SampleUser
    vserver: ansibleVServer
    group_id: 1
    id: 2
    full_name: Test User
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Delete UNIX User
  netapp.ontap.na_ontap_unix_user:
    state: absent
    name: SampleUser
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

作者

  • NetApp Ansible 团队 (@carchi8py)