netapp.ontap.na_ontap_svm 模块 – NetApp ONTAP SVM

注意

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

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

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

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

netapp.ontap 2.6.0 中的新增功能

概要

  • 在 NetApp ONTAP 上创建、修改或删除 SVM

要求

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

  • Ansible 2.9 或更高版本 - 建议使用 2.12 或更高版本。

  • Python 3 - 建议使用 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 或更高版本。

参数

参数

注释

admin_state

字符串

在 netapp.ontap 21.15.0 中添加

创建 SVM 时，它将处于运行状态，除非另有指定。

这在 ZAPI 中被忽略。

选项

  • "running"

  • "stopped"

aggr_list

列表 / 元素=字符串

为卷操作分配的聚合列表。

这些聚合可以与其他 Vserver 共享。

在 vserver-create 中指定时，此字段表示分配给 Vserver 用于卷操作的聚合列表。

作为 vserver-get-iter 调用的部分时，这将返回具有作为 aggr 列表一部分指定的任何聚合的 Vserver 列表。

allowed_protocols

列表 / 元素=字符串

允许的协议。

此字段表示 Vserver 上允许的协议列表。

在修改时，此字段应包含现有列表以及要添加的新协议列表，以防止数据中断。

可能的值

nfs NFS 协议，

cifs CIFS 协议，

fcp FCP 协议，

iscsi iSCSI 协议，

ndmp NDMP 协议，

s3 S3 协议，

http HTTP 协议 - 仅限 ZAPI，

nvme NVMe 协议

cert_filepath

字符串

在 netapp.ontap 20.6.0 中添加

SSL 客户端证书文件（.pem）的路径。

python 2.6 不支持。

comment

字符串

在 netapp.ontap 2.8.0 中添加

在 vserver-create 中指定时，此字段表示与 Vserver 关联的注释。

作为 vserver-get-iter 调用的部分时，这将返回匹配的 Vserver 列表。

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 中被忽略。

from_name

字符串

在 netapp.ontap 2.7.0 中添加

要重命名的 SVM 的名称

hostname

字符串 / 必需

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

http_port

整数

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

https

布尔值

启用和禁用 https。

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

使用 SSL 证书认证时被忽略，因为它需要 SSL。

选项

  • false ← (默认)

  • true

ignore_rest_unsupported_options

布尔值

在 netapp.ontap 21.10.0 中添加

如果目标支持 REST，则为真时忽略 root_volume、root_volume_aggregate、root_volume_security_style 选项。

当 use_rest 设置为 never 时被忽略。

选项

  • false ← (默认)

  • true

ipspace

字符串

在 netapp.ontap 2.7.0 中添加

IP 空间名称

创建后无法修改。

key_filepath

字符串

在 netapp.ontap 20.6.0 中添加

SSL 客户端密钥文件路径。

language

字符串

在 netapp.ontap 2.7.0 中添加

SVM 使用的语言

默认为 C.UTF-8

可能的语言值

c POSIX

ar 阿拉伯语

cs 捷克语

da 丹麦语

de 德语

en 英语

en_us 美国英语

es 西班牙语

fi 芬兰语

fr 法语

he 希伯来语

hr 克罗地亚语

hu 匈牙利语

it 意大利语

ja 日语 euc-j

ja_v1 日语 euc-j

ja_jp.pck 日文 PCK (sjis)

ja_jp.932 日文 cp932

ja_jp.pck_v2 日文 PCK (sjis)

ko 韩语

no 挪威语

nl 荷兰语

pl 波兰语

pt 葡萄牙语

ro 罗马尼亚语

ru 俄语

sk 斯洛伐克语

sl 斯洛文尼亚语

sv 瑞典语

tr 土耳其语

zh 简体中文

zh.gbk 简体中文 (GBK)

zh_tw 繁体中文 euc-tw

zh_tw.big5 繁体中文 Big 5

utf8mb4

大多数值接受 .utf_8 后缀，例如 fr.utf_8

max_volumes

字符串

在 netapp.ontap 21.12.0 中添加

可在 vserver 上创建的卷的最大数量。

需要整数或 unlimited。

名称

别名：vserver

字符串 / 必需

要管理的 SVM 的名称。

使用 module_defaults 时，vserver 是一个方便的别名。

ontapi

整数

要使用的 ontap api 版本

密码

别名：pass

字符串

指定用户的密码。

root_volume

字符串

SVM 的根卷。

创建后无法修改。

root_volume_aggregate

字符串

将创建根卷的聚合。

创建后无法修改。

root_volume_security_style

字符串

根卷的安全样式。

在 vserver 创建中指定时，此字段表示 Vserver 根卷的安全样式。

在 vserver-get-iter 调用中指定时，这将返回匹配的 Vserver 列表。

仅适用于无限卷的“unified”安全样式不能应用于 Vserver 的根卷。

创建后无法修改。

选项

  • "unix"

  • "ntfs"

  • "mixed"

  • "unified"

services

字典

在 netapp.ontap 21.10.0 中添加

启用的协议，仅适用于 REST。

如有需要，服务将启动。可能需要有效的许可证。

enabled 不支持 CIFS，要启用它，请使用 na_ontap_cifs_server。

enabled 不支持 s3，要启用它，请使用 na_ontap_s3_services。

如果服务不存在，则保持不变。

cifs

字典

CIFS 协议服务

allowed

布尔值

如果为真，则 SVM 管理员可以管理 CIFS 服务。如果为假，则只有集群管理员可以管理该服务。

选项

  • false

  • true

fcp

字典

FCP 协议服务

allowed

布尔值

如果为真，则 SVM 管理员可以管理 FCP 服务。如果为假，则只有集群管理员可以管理该服务。

选项

  • false

  • true

enabled

布尔值

如果允许，设置为 true 将启用 FCP 服务。

选项

  • false

  • true

iscsi

字典

iSCSI 协议服务

allowed

布尔值

如果为真，则 SVM 管理员可以管理 iSCSI 服务。如果为假，则只有集群管理员可以管理该服务。

选项

  • false

  • true

enabled

布尔值

如果允许，设置为 true 将启用 iSCSI 服务。

选项

  • false

  • true

ndmp

字典

在 netapp.ontap 21.24.0 中添加

网络数据管理协议服务

allowed

布尔值

如果设置为 true，则 SVM 管理员可以管理 NDMP 服务

如果为 false，则只有集群管理员可以管理该服务。

需要 ONTAP 9.10.1 或更高版本。

选项

  • false

  • true

nfs

字典

NFS 协议服务

allowed

布尔值

如果为真，则 SVM 管理员可以管理 NFS 服务。如果为假，则只有集群管理员可以管理该服务。

选项

  • false

  • true

enabled

布尔值

如果允许，设置为 true 将启用 NFS 服务。

选项

  • false

  • true

nvme

字典

nvme 协议服务

allowed

布尔值

如果为真，则 SVM 管理员可以管理 NVMe 服务。如果为假，则只有集群管理员可以管理该服务。

选项

  • false

  • true

enabled

布尔值

如果允许，设置为 true 将启用 NVMe 服务。

选项

  • false

  • true

s3

字典

s3 服务

allowed

布尔值

如果为真，则 SVM 管理员可以管理 s3 服务。如果为假，则只有集群管理员可以管理该服务。

需要 ONTAP 9.7.0 或更高版本。

选项

  • false

  • true

snapshot_policy

字符串

在 netapp.ontap 2.7.0 中添加

所有 Vserver 卷的默认快照策略设置。除非卷创建请求明确提供快照策略或卷稍后使用特定快照策略进行修改，否则此策略将分配给在此 Vserver 中创建的所有卷。卷级快照策略始终会覆盖默认的 Vserver 范围快照策略。

state

字符串

指定的 SVM 是否应该存在。

选项

  • "present" ← (默认)

  • "absent"

subtype

字符串

在 netapp.ontap 2.7.0 中添加

要创建的 vserver 的子类型。

创建后无法修改。

选项

  • "default"

  • "dp_destination"

  • "sync_source"

  • "sync_destination"

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

web

字典

web 服务安全配置。

证书名称需要 ONTAP 9.8 或更高版本。

其他选项需要 ONTAP 9.10.1 或更高版本。

certificate

字符串

集群和节点管理接口用于 TLS 连接请求的证书名称。

证书必须为“server”类型。

client_enabled

布尔值

客户端身份验证是否启用。

选项

  • false

  • true

ocsp_enabled

布尔值

在线证书状态协议验证是否启用。

选项

  • false

  • true

备注

注意

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

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

示例

- name: Create SVM
  netapp.ontap.na_ontap_svm:
    state: present
    name: ansibleVServer
    root_volume: vol1
    root_volume_aggregate: aggr1
    root_volume_security_style: mixed
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create SVM
  netapp.ontap.na_ontap_svm:
    state: present
    services:
      cifs:
        allowed: true
      fcp:
        allowed: true
      nfs:
        allowed: true
        enabled: true
      s3:
        allowed: true
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Stop SVM REST
  netapp.ontap.na_ontap_svm:
    state: present
    name: ansibleVServer
    admin_state: stopped
    use_rest: always
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

作者

  • NetApp Ansible 团队 (@carchi8py)