netapp.ontap.na_ontap_volume 模块 – 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_volume

netapp.ontap 2.6.0 中的新增功能

概要

  • 在 NetApp ONTAP 上创建、销毁或修改卷。

要求

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

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

参数

参数

注释

activity_tracking

字符串

netapp.ontap 22.12.0 中新增

设置卷的活动跟踪状态。

仅支持 REST,需要 ONTAP 9.10 或更高版本。

选项

  • "on"

  • "off"

aggr_list

列表 / 元素=字符串

netapp.ontap 2.8.0 中新增

用于 FlexGroup 成员的聚合名称数组。

aggr_list_multiplier

整数

netapp.ontap 2.8.0 中新增

创建 FlexGroup 时,迭代使用 aggr_list 参数列出的聚合的次数。

aggregate_name

字符串

flexvol 应该存在的聚合的名称。

使用 nas_application_template 选项时,不能设置。

analytics

字符串

netapp.ontap 22.0.0 中新增

设置卷的文件系统分析状态。

仅支持 REST,需要 ONTAP 9.8 或更高版本。

不能为包含 LUN 的卷启用分析。

选项

  • "on"

  • "off"

atime_update

布尔值

netapp.ontap 2.8.0 中新增

这是一个高级选项,默认为 True。

如果为 false,则在读取文件时阻止更新 inode 访问时间。

对于读取流量极高的卷,此值很有用,因为它可以防止写入卷的 inode 文件与来自其他文件的读取竞争。

此字段应谨慎使用。

也就是说,只有当您预先知道该卷上文件的 inode 正确访问时间不需要时,才使用此字段。

此选项在 ONTAP 9.8 或更高版本(使用 ONTAP 集合版本 22.8.0 或更高版本)的 REST 中受支持。

选项

  • false

  • true

auto_provision_as

字符串

netapp.ontap 2.8.0 中新增

自动配置 FlexGroup 卷。

选项

  • "flexgroup"

auto_remap_luns

布尔值

netapp.ontap 20.6.0 中新增

控制 LUN 自动映射的标志。

选项

  • false

  • true

cert_filepath

字符串

netapp.ontap 20.6.0 中新增

SSL 客户端证书文件(.pem)的路径。

python 2.6 不支持。

check_interval

整数

netapp.ontap 20.6.0 中新增

检查卷以查看其是否已成功移动的时间间隔(秒)。

默认值: 30

comment

字符串

netapp.ontap 2.9.0 中新增

设置与卷关联的注释。

compression

布尔值

netapp.ontap 20.12.0 中新增

是否为卷启用压缩(HDD 和 Flash Pool 聚合)。

如果此选项不存在,则如果 inline_compression 为 true,则会自动将其设置为 true。

选项

  • false

  • true

cutover_action

字符串

netapp.ontap 20.5.0 中新增

指定要对切换执行的操作。

可能的值为“abort_on_failure”、“defer_on_failure”、“force”和“wait”。默认为“defer_on_failure”。

选项

  • "abort_on_failure"

  • "defer_on_failure"

  • "force"

  • "wait"

efficiency_policy

字符串

netapp.ontap 2.7.0 中新增

允许在卷创建时设置存储效率策略。

encrypt

布尔值

netapp.ontap 2.7.0 中新增

是否启用卷加密。

如果不存在,ONTAP 在卷创建时默认为 false。

创建后更改 encrypt 值需要 ONTAP 9.3 或更高版本。

选项

  • false

  • true

export_policy

别名:policy

字符串

导出策略的名称。

与 nas_application_template 中的 nfs_access 子选项互斥。

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

ZAPI 中忽略。

force_restore

布尔值

netapp.ontap 20.6.0 中新增

如果此字段设置为“true”,即使卷具有一个或多个当前用作 SnapMirror 参考快照副本的较新快照副本,也会还原快照副本。如果在这种情况下执行还原,则会导致将来的 SnapMirror 传输失败。

此选项应仅与 snapshot_restore 一起使用。

选项

  • false

  • true

force_unmap_luns

布尔值

netapp.ontap 20.6.0 中新增

控制 LUN 自动取消映射的标志。

选项

  • false

  • true

from_name

字符串

netapp.ontap 2.7.0 中新增

要重命名为 name 的现有卷的名称。

from_vserver

字符串

netapp.ontap 20.6.0 中新增

卷的源 vserver 已重新托管。

granular_data

布尔值

在 netapp.ontap 22.13.0 中添加

卷上粒度数据的状态。

只有 FlexGroup 卷支持此功能。启用后,只能通过还原快照副本来禁用此设置。

仅支持 REST 并需要 ONTAP 9.12 或更高版本。

选项

  • false

  • true

group_id

整数

在 netapp.ontap 20.1.0 中添加

卷的 UNIX 组 ID。默认值为 0(“root”)。

hostname

字符串 / 必需

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

http_port

整数

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

https

布尔值

启用和禁用 https。

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

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

选项

  • false ← (默认)

  • true

inline_compression

布尔值

netapp.ontap 20.12.0 中新增

是否为卷启用内联压缩(HDD 和 Flash Pool 聚集体,AFF 平台)。

选项

  • false

  • true

is_infinite

布尔值

如果卷是无限卷,则设置为 True。

删除无限卷是异步的。

选项

  • false ← (默认)

  • true

is_online

布尔值

指定卷是否联机。

选项

  • false

  • true ← (默认)

junction_path

字符串

卷的连接路径。

要卸载,请使用连接路径''

key_filepath

字符串

netapp.ontap 20.6.0 中新增

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

language

字符串

netapp.ontap 2.8.0 中新增

卷使用的语言

默认使用 SVM 语言

可能的语言值

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

要使用 UTF-8 作为 NFS 字符集,请在语言代码后附加“.UTF-8”。

logical_space_enforcement

布尔值

在 netapp.ontap 21.16.0 中添加

这可以选择性地指定是否对卷执行逻辑空间核算。当逻辑上强制执行空间时,ONTAP 会强制执行卷设置,以便存储效率功能节省的所有物理空间都将计算为已使用。

这仅受 REST 支持。

选项

  • false

  • true

logical_space_reporting

布尔值

在 netapp.ontap 21.16.0 中添加

这可以选择性地指定是否在卷上逻辑地报告空间。当逻辑上报告空间时,ONTAP 会报告卷空间,以便存储效率功能节省的所有物理空间也会报告为已使用。

这仅受 REST 支持。

选项

  • false

  • true

max_files

整数

在 netapp.ontap 21.18.0 中添加

卷上允许用于用户可见数据的最大文件数(inode)。

注意 - ONTAP 分配的值略有不同,例如,请求 4000 时为 3990。为了保持幂等性,忽略大小上的微小差异。

max_wait_time

整数

netapp.ontap 22.0.0 中新增

卷移动和加密操作可能需要更长的时间才能完成。

设置wait_for_completion后,模块将等待在此选项中设置的时间,以完成卷移动和加密。

如果时间到期,模块将退出,并且操作可能仍在运行。

默认为 10 分钟。

默认值: 600

name

字符串 / 必需

要管理的卷的名称。

nas_application_template

字典

netapp.ontap 20.12.0 中新增

使用 application/applications REST API 创建卷时的附加选项。

模块默认使用 ZAPI,如果存在任何子选项,则切换到 REST。

默认情况下创建 FlexVol。

如果设置了auto_provision_as并且不存在FlexCache选项,则创建 FlexGroup。

如果存在flexcache选项,则创建 FlexCache。

cifs_access

列表 / 元素=字典

CIFS 访问控制列表。必须提供user_or_groupaccess才能启用 CIFS 访问。

access

字符串

授予用户或组的 CIFS 访问权限。默认为 full_control。

选项

  • "change"

  • "full_control"

  • "no_access"

  • "read"

user_or_group

字符串

将被授予访问权限的 CIFS 用户或组的名称。默认为 Everyone。

cifs_share_name

字符串

在 netapp.ontap 22.13.0 中添加

CIFS 共享的名称。

需要 ONTAP 9.11 或更高版本。

exclude_aggregates

列表 / 元素=字符串

在 netapp.ontap 21.7.0 中添加

创建卷时要排除的聚集体名称列表。

需要 ONTAP 9.9.1 GA 或更高版本。

flexcache

字典

是否创建 flexcache。如果不存在,则创建 FlexVol 或 FlexGroup。

dr_cache

布尔值

在 netapp.ontap 21.3.0 中添加

是否使用与原点相同的 flexgroup msid。

需要 ONTAP 9.9 和 REST。

仅创建选项,如果 flexcache 已经存在则忽略。

选项

  • false

  • true

origin_component_name

字符串 / 必需

flexcache 的远程组件。

origin_svm_name

字符串 / 必需

flexcache 的远程 SVM。

nfs_access

列表 / 元素=字典

NFS 访问控制列表。必须提供hostaccess才能启用 NFS 访问。

与 export_policy 选项互斥。

access

字符串

授予的 NFS 访问权限。默认为 rw。

选项

  • "none"

  • "ro"

  • "rw"

host

字符串

被授予访问权限的 NFS 实体的名称。默认为 0.0.0.0/0。

snaplock

字典

在 netapp.ontap 22.13.0 中添加

需要 ONTAP 9.12 或更高版本。

append_mode_enabled

布尔值

指定卷追加模式是启用还是禁用。

选项

  • false

  • true

autocommit_period

字符串

指定 SnapLock 卷的自动提交周期。

持续时间采用 ISO-8601 持续时间格式(例如 PY、PM、PD、PTH、PTM)。

示例为 P30M、P10Y、PT1H、none。不支持组合不同周期的持续时间。

retention

字典

提交到卷上 WORM 状态的文件的默认、最大和最小保留期限。

持续时间采用 ISO-8601 持续时间格式,请参见 autocommit_period。

default

字符串

在没有关联保留期限的情况下将文件提交到 WORM 状态时应用的默认保留期限。

maximum

字符串

提交到卷上 WORM 状态的文件允许的最大保留期限。

minimum

字符串

提交到卷上 WORM 状态的文件允许的最小保留期限。

snaplock_type

字符串

智能容器的 SnapLock 类型。

选项

  • "compliance"

  • "enterprise"

  • "non_snaplock"

snapshot_locking_enabled

布尔值

在 netapp.ontap 22.13.0 中添加

指示卷上是否启用了快照副本锁定。

需要 ONTAP 9.13.1 或更高版本。

选项

  • false

  • true

storage_service

字符串

此卷的性能服务级别 (PSL)

选项

  • "value"

  • "performance"

  • "extreme"

tiering

字典

云分层策略(有关更完整的说明,请参见tiering_policy)。

control

字符串

容器的存储分层放置规则。

选项

  • "required"

  • "best_effort"

  • "disallowed"

object_stores

列表 / 元素=字符串

用于分层的对象存储名称列表。

policy

字符串

云分层策略(请参见tiering_policy)。

如果两者都存在,则必须与tiering_policy匹配。

选项

  • "all"

  • "auto"

  • "none"

  • "snapshot-only"

use_nas_application

布尔值

是否使用 application/applications REST/API 创建卷。

如果存在任何其他子选项,则默认为 true。

选项

  • false

  • true ← (默认)

nvfail_enabled

布尔值

netapp.ontap 2.9.0 中新增

如果为 true,则控制器在引导和接管时会执行其他工作,如果它发现由于 NVRAM 故障导致卷的组成部分存在任何潜在的数据丢失。

卷的组成部分将置于一种称为“in-nvfailed-state”的特殊状态,从而阻止协议访问。

这将导致客户端应用程序崩溃,从而阻止对陈旧数据的访问。

要摆脱这种情况,管理员需要手动清除卷组成部分上的“in-nvfailed-state”。

选项

  • false

  • true

ontapi

整数

要使用的 ontap api 版本

密码

别名:pass

字符串

指定用户的密码。

percent_snapshot_space

整数

为卷的快照副本保留的空间量。

preserve_lun_ids

布尔值

netapp.ontap 20.6.0 中新增

如果此字段设置为“true”,则被还原卷中的 LUN 将保持映射状态并保留其身份,以便在还原操作期间不会中断主机连接。通过将 LUN 置于不可用状态,在还原操作期间将对 LUN 的 I/O 进行隔离。还原操作完成后,主机将能够恢复对 LUN 的 I/O 访问。

此选项应仅与 snapshot_restore 一起使用。

选项

  • false

  • true

qos_adaptive_policy_group

字符串

netapp.ontap 2.9.0 中新增

指定要设置在卷上的 QoS 自适应策略组。

qos_policy_group

字符串

netapp.ontap 2.9.0 中新增

指定要设置在卷上的 QoS 策略组。

size

整数

卷的大小(size_unit)。当state=present时必需。

size_change_threshold

整数

netapp.ontap 20.12.0 中新增

触发调整大小的大小变化百分比。

当此参数大于 0 时,如果预期大小与配置大小之间的差异低于阈值,则忽略该差异。

例如,nas 应用程序分配的大小大于指定的大小,以考虑开销。

将其设置为 0 以进行精确匹配。

默认值: 10

size_unit

字符串

用于解释 size 参数的单位。

选项

  • "bytes"

  • "b"

  • "kb"

  • "mb"

  • "gb" ← (默认)

  • "tb"

  • "pb"

  • "eb"

  • "zb"

  • "yb"

sizing_method

字符串

netapp.ontap 20.12.0 中新增

表示修改 FlexGroup 大小的方法。

use_existing_resources - 通过增加或减少当前 FlexGroup 资源的大小来增加或减少 FlexGroup 的大小。

add_new_resources - 通过添加新的资源来增加 FlexGroup 的大小。这限制为每个可用聚合最多添加两个新资源。

只有在启用 REST(ONTAP 9.6 或更高版本)且仅适用于 FlexGroup 时才支持此功能。ONTAP 默认使用 use_existing_resources。

选项

  • "add_new_resources"

  • "use_existing_resources"

snapdir_access

布尔值

netapp.ontap 2.8.0 中新增

这是一个高级选项,默认为 False。

启用通常存在于系统内部挂载点的可见“.snapshot”目录。

此值还会打开对卷中所有其他“.snapshot”目录的访问。

此选项在 ONTAP 9.13.1 或更高版本中支持 REST,且需要 ONTAP 集合版本 22.8.0 或更高版本。

选项

  • false

  • true

snaplock

字典

在 netapp.ontap 21.18.0 中添加

从 ONTAP 9.10.1 开始,snaplock.type 在卷级别设置。

在较早版本的 ONTAP 上使用 REST 时,可以设置或修改其他子选项。

这些选项和子选项仅在使用 REST 时受支持。

append_mode_enabled

布尔值

启用后,默认情况下,在卷上创建的所有具有写权限的文件都是 WORM 追加文件。用户可以将数据追加到 WORM 追加文件,但不能修改文件的现有内容,也不能删除文件,直到文件过期。

选项

  • false

  • true

autocommit_period

字符串

SnapLock 卷的自动提交周期。所有未修改时间超过卷自动提交周期的文件都将提交到 WORM 状态。

持续时间采用 ISO-8601 持续时间格式(例如 PY、PM、PD、PTH、PTM)。

例如 P30M、P10Y、PT1H、“none”。不支持组合不同周期的持续时间。

privileged_delete

字符串

SnapLock 卷的 privileged-delete 属性。

在 SnapLock Enterprise (SLE) 卷上,指定的特权用户可以有选择地删除文件,而不管文件的保留时间如何。

在 SnapLock Compliance (SLC) 卷上,它始终为 permanently_disabled。

选项

  • "disabled"

  • "enabled"

  • "permanently_disabled"

retention

字典

提交到卷上 WORM 状态的文件的默认、最大和最小保留期限。

持续时间采用 ISO-8601 持续时间格式,请参见 autocommit_period。

default

字符串

在将文件提交到 WORM 状态而没有关联的保留期限时应用的默认保留期限。

maximum

字符串

提交到卷上 WORM 状态文件的最大允许保留期限。

minimum

字符串

提交到卷上 WORM 状态文件的最小允许保留期限。

type

字符串

卷的 SnapLock 类型。

compliance - SnapLock Compliance (SLC) 卷提供最高级别的 WORM 保护,如果 SLC 卷包含未过期的 WORM 文件,则管理员无法销毁该卷。

enterprise - 管理员可以删除 SnapLock Enterprise (SLE) 卷。

non_snaplock - 指示卷是非 SnapLock 卷。

选项

  • "compliance"

  • "enterprise"

  • "non_snaplock"

snapshot_auto_delete

字典

添加到 netapp.ontap 20.4.0

自动删除选项和值的字典。

支持的选项包括“state”、“commitment”、“trigger”、“target_free_space”、“delete_order”、“defer_delete”、“prefix”、“destroy_list”。

除“destroy_list”之外,所有上述选项在 ONTAP 9.13.1 或更高版本中都支持 REST,且需要 ONTAP 集合版本 22.8.0 或更高版本。

选项“state”确定卷的快照自动删除当前是否启用。可能的值为“on”和“off”。

选项“commitment”确定快照自动删除允许删除哪些快照以回收空间。可能的值为“try”、“disrupt”和“destroy”。

选项“trigger”确定启动快照自动删除的条件。可能的值为“volume”、“snap_reserve”和已弃用的“space_reserve”。

选项“target_free_space”确定快照自动删除应何时停止删除快照。根据触发器,快照将被删除,直到达到目标空闲空间百分比。接受 int 类型。

选项“delete_order”确定首先删除最旧的快照还是最新的快照。可能的值为“newest_first”和“oldest_first”。

选项“defer_delete”确定最终删除哪种快照。可能的值为“scheduled”、“user_created”、“prefix”和“none”。

可以设置选项“prefix”来为“defer_delete”选项的“prefix”值提供前缀字符串。前缀字符串长度可以为 15 个字符。

选项“destroy_list”是可销毁的服务的逗号分隔列表,如果支持该服务的快照被删除,则可以销毁这些服务。对于 7-mode,此选项的可能值为“lun_clone”、“vol_clone”、“cifs_share”、“file_clone”或“none”的组合。对于集群模式,此选项的可能值为“lun_clone,file_clone”(对于 LUN 克隆和/或文件克隆),“lun_clone,sfsr”(对于 LUN 克隆和/或 sfsr),“vol_clone”、“cifs_share”或“none”。

snapshot_locking

布尔值

netapp.ontap 22.12.0 中新增

指定是否在卷上启用快照副本锁定。

仅支持 REST 并需要 ONTAP 9.12 或更高版本。

选项

  • false

  • true

snapshot_policy

字符串

netapp.ontap 2.8.0 中新增

快照策略的名称。

默认策略名称为“default”。

如果存在,这将在使用nas_application_template时设置 protection_type。

snapshot_restore

字符串

netapp.ontap 20.6.0 中新增

要从中恢复快照的名称。

在无限卷上不受支持。

space_guarantee

字符串

卷的空间保证样式。

文件设置不再受支持。

选项

  • "none"

  • "file"

  • "volume"

space_slo

字符串

netapp.ontap 2.9.0 中新增

指定卷的空间 SLO 类型。空间 SLO 类型是卷空间管理的服务级别目标。

空间 SLO 值用于强制执行现有的卷设置,以便在聚合上预留足够的空间以满足空间 SLO。

此参数在无限卷上不受支持。

选项

  • "none"

  • "thick"

  • "semi-thick"

state

字符串

指定卷是否存在。

选项

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

添加到 netapp.ontap 22.6.0

标签是跟踪资源用法的可选方法。

标签值必须格式化为键值对字符串,例如 [“team:csi”、“environment:test”]。

tiering_minimum_cooling_days

整数

在 netapp.ontap 21.16.0 中添加

确定在使用自动策略或仅快照策略的卷中,非活动数据被视为冷数据并有资格进行分层之前必须经过多少天。

此选项仅在 REST 9.8 或更高版本中受支持。

tiering_policy

字符串

netapp.ontap 2.9.0 中新增

要与卷关联的分层策略。

此策略决定卷的块是否将分层到容量层。

仅快照策略允许仅分层与活动文件系统无关的卷快照副本。

自动策略允许将快照和活动文件系统用户数据都分层到容量层。

DP 卷上的备份策略允许所有传输的用户数据块从容量层开始。

all 是备份的 REST 等效项。

设置为 none 时,卷块不会分层到容量层。

如果未指定值,则卷默认分配仅快照。

需要 ONTAP 9.4 或更高版本。

选项

  • "snapshot-only"

  • "auto"

  • "backup"

  • "none"

  • "all"

time_out

整数

netapp.ontap 2.8.0 中新增

使用 ZAPI - 以秒为单位等待 Flexgroup 创建、修改或删除的时间。

使用 REST - 以秒为单位等待任何卷创建、修改或删除的时间。

如果在定义的时间内未完成任务,则出错。

使用 ZAPI - 如果为 0,则请求为异步请求。

默认为 3 分钟。

对于卷移动和加密操作,请使用max_wait_timewait_for_completion

默认: 180

type

字符串

卷类型,读写 (RW) 或数据保护 (DP)。

unix_permissions

字符串

netapp.ontap 2.8.0 中新增

以八进制或符号格式表示的 Unix 权限位。

例如,0 等效于 ————,777 等效于 —rwxrwxrwx,两种格式都可接受。

有效的八进制值范围在 0 到 777(含)之间。

use_rest

字符串

是否使用 REST 或 ZAPI。

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

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

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

默认: "auto"

user_id

整数

在 netapp.ontap 20.1.0 中添加

卷的 UNIX 用户 ID。默认值为 0(“root”)。

用户名

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

vol_full_threshold_percent

整数

添加到 netapp.ontap 22.8.0

指定卷被视为已满的百分比,超过此百分比将生成关键 EMS 错误。

默认值为 98%。此选项的最大值为 100%。

将此阈值设置为 0 将禁用卷已满空间警报。

仅在使用 REST 并需要 ONTAP 9.9 或更高版本时才受支持。

vol_nearly_full_threshold_percent

整数

添加到 netapp.ontap 22.8.0

指定卷被视为接近已满的百分比,超过此百分比将生成 EMS 警告。

默认值为 95%。此选项的最大值为 99%。

将此阈值设置为 0 将禁用卷接近已满空间警报。

仅在使用 REST 并需要 ONTAP 9.9 或更高版本时才受支持。

volume_security_style

字符串

与此卷关联的安全样式。

选项

  • "mixed"

  • "ntfs"

  • "unified"

  • "unix"

vserver

字符串 / 必需

要使用的 vserver 的名称。

vserver_dr_protection

字符串

netapp.ontap 2.9.0 中新增

指定 Vserver DR 设置中卷的保护类型。

选项

  • "protected"

  • "unprotected"

wait_for_completion

布尔值

netapp.ontap 2.8.0 中新增

在创建期间将此参数设置为“true”以进行同步执行(等待直到卷状态联机)

将此参数设置为“false”以进行异步执行

对于异步执行,一旦发送请求,就会立即退出,而无需检查卷状态

选项

  • false ← (默认)

  • true

备注

注意

  • 支持 REST 和 ZAPI。REST 需要 ONTAP 9.6 或更高版本。REST 的效率需要 ONTAP 9.7 或更高版本。

  • use_rest设置为 always 时,启用 REST。

  • 特性标志 warn_or_fail_on_fabricpool_backend_change 控制是否在分层控制需要或禁止对具有不同后端的现有卷使用 FabricPool 时报告错误。允许的值为 fail、warn 和 ignore,默认值为 fail。

  • snapshot_restore 不是幂等的,它总是执行恢复操作。

  • 以 na_ontap 为前缀的模块构建用于支持 ONTAP 存储平台。

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

示例

- name: Create FlexVol
  netapp.ontap.na_ontap_volume:
    state: present
    name: ansibleVolume12
    is_infinite: False
    aggregate_name: ansible_aggr
    size: 100
    size_unit: mb
    user_id: 1001
    group_id: 2002
    space_guarantee: none
    tiering_policy: auto
    export_policy: default
    percent_snapshot_space: 60
    qos_policy_group: max_performance_gold
    vserver: ansibleVServer
    wait_for_completion: True
    space_slo: none
    nvfail_enabled: False
    comment: ansible created volume
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Volume Delete
  netapp.ontap.na_ontap_volume:
    state: absent
    name: ansibleVolume12
    aggregate_name: ansible_aggr
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Make FlexVol offline
  netapp.ontap.na_ontap_volume:
    state: present
    name: ansibleVolume
    is_infinite: False
    is_online: False
    vserver: ansibleVServer
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Create Flexgroup volume manually
  netapp.ontap.na_ontap_volume:
    state: present
    name: ansibleVolume
    is_infinite: False
    aggr_list: "{{ aggr_list }}"
    aggr_list_multiplier: 2
    size: 200
    size_unit: mb
    space_guarantee: none
    export_policy: default
    vserver: "{{ vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: False
    unix_permissions: 777
    snapshot_policy: default
    time_out: 0

- name: Create Flexgroup volume auto provsion as flex group
  netapp.ontap.na_ontap_volume:
    state: present
    name: ansibleVolume
    is_infinite: False
    auto_provision_as: flexgroup
    size: 200
    size_unit: mb
    space_guarantee: none
    export_policy: default
    vserver: "{{ vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: False
    unix_permissions: 777
    snapshot_policy: default
    time_out: 0

- name: Create FlexVol with QoS adaptive
  netapp.ontap.na_ontap_volume:
    state: present
    name: ansibleVolume15
    is_infinite: False
    aggregate_name: ansible_aggr
    size: 100
    size_unit: gb
    space_guarantee: none
    export_policy: default
    percent_snapshot_space: 10
    qos_adaptive_policy_group: extreme
    vserver: ansibleVServer
    wait_for_completion: True
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"

- name: Modify volume dr protection (vserver of the volume must be in a snapmirror relationship)
  netapp.ontap.na_ontap_volume:
    state: present
    name: ansibleVolume
    vserver_dr_protection: protected
    vserver: "{{ vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: False

- name: Modify volume with snapshot auto delete options
  netapp.ontap.na_ontap_volume:
    state: present
    name: vol_auto_delete
    snapshot_auto_delete:
      state: "on"
      commitment: try
      defer_delete: scheduled
      target_free_space: 30
      destroy_list: lun_clone,vol_clone
      delete_order: newest_first
    aggregate_name: "{{ aggr }}"
    vserver: "{{ vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: False

- name: Move volume with force cutover action
  netapp.ontap.na_ontap_volume:
    name: ansible_vol
    aggregate_name: aggr_ansible
    cutover_action: force
    vserver: "{{ vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: false

- name: Rehost volume to another vserver auto remap luns
  netapp.ontap.na_ontap_volume:
    name: ansible_vol
    from_vserver: ansible
    auto_remap_luns: true
    vserver: "{{ vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: false

- name: Rehost volume to another vserver force unmap luns
  netapp.ontap.na_ontap_volume:
    name: ansible_vol
    from_vserver: ansible
    force_unmap_luns: true
    vserver: "{{ vserver }}"
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: false

- name: Snapshot restore volume
  netapp.ontap.na_ontap_volume:
    name: ansible_vol
    vserver: ansible
    snapshot_restore: 2020-05-24-weekly
    force_restore: true
    preserve_lun_ids: true
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

- name: Volume create using application/applications nas template
  netapp.ontap.na_ontap_volume:
    state: present
    name: ansibleVolume12
    vserver: ansibleSVM
    size: 100000000
    size_unit: b
    space_guarantee: none
    language: es
    percent_snapshot_space: 60
    unix_permissions: ---rwxrwxrwx
    snapshot_policy: default
    efficiency_policy: default
    comment: testing
    nas_application_template:
      nfs_access:   # the mere presence of a suboption is enough to enable this new feature
        - access: ro
        - access: rw
          host: 10.0.0.0/8
      exclude_aggregates: aggr0
    hostname: "{{ netapp_hostname }}"
    username: "{{ netapp_username }}"
    password: "{{ netapp_password }}"
    https: true
    validate_certs: false

# requires Ontap collection version - 21.24.0 to use iso filter plugin.
- name: volume create with snaplock set.
  netapp.ontap.na_ontap_volume:
    state: present
    name: "{{ snaplock_volume }}"
    aggregate_name: "{{ aggregate }}"
    size: 20
    size_unit: mb
    space_guarantee: none
    policy: default
    type: rw
    snaplock:
      type: enterprise
      retention:
        default: "{{ 60 | netapp.ontap.iso8601_duration_from_seconds }}"

- name: Create volume with snapshot-auto-delete options - REST
  netapp.ontap.na_ontap_volume:
    state: present
    name: test_vol
    aggregate_name: "{{ aggr }}"
    size: 20
    size_unit: mb
    snapshot_auto_delete:
      state: 'on'
      trigger: volume
      delete_order: "oldest_first"
      defer_delete: "user_created"
      commitment: "try"
      target_free_space: 30
      prefix: "my_prefix"
    wait_for_completion: true

- name: Modify volume - REST
  netapp.ontap.na_ontap_volume:
    state: present
    name: test_vol
    aggregate_name: "{{ aggr }}"
    snapdir_access: false
    snapshot_auto_delete:
      state: 'on'
      target_free_space: 25

作者

  • NetApp Ansible 团队 (@carchi8py)